google_api_storage v0.6.0 GoogleApi.Storage.V1.Api.Notifications View Source

API calls for all endpoints tagged Notifications.

Link to this section Summary

Link to this section Functions

Link to this function

storage_notifications_delete(connection, bucket, notification, optional_params \\ [], opts \\ []) View Source

Permanently deletes a notification subscription.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): The parent bucket of the notification.
  • notification (String.t): ID of the notification to delete.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :provisionalUserProject (String.t): The project to be billed for this request if the target bucket is requester-pays bucket.
    • :userProject (String.t): The project to be billed for this request. Required for Requester Pays buckets.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

storage_notifications_get(connection, bucket, notification, optional_params \\ [], opts \\ []) View Source

View a notification configuration.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): The parent bucket of the notification.
  • notification (String.t): Notification ID
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :provisionalUserProject (String.t): The project to be billed for this request if the target bucket is requester-pays bucket.
    • :userProject (String.t): The project to be billed for this request. Required for Requester Pays buckets.

Returns

{:ok, %GoogleApi.Storage.V1.Model.Notification{}} on success {:error, info} on failure

Link to this function

storage_notifications_insert(connection, bucket, optional_params \\ [], opts \\ []) View Source

Creates a notification subscription for a given bucket.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): The parent bucket of the notification.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :provisionalUserProject (String.t): The project to be billed for this request if the target bucket is requester-pays bucket.
    • :userProject (String.t): The project to be billed for this request. Required for Requester Pays buckets.
    • :body (Notification):

Returns

{:ok, %GoogleApi.Storage.V1.Model.Notification{}} on success {:error, info} on failure

Link to this function

storage_notifications_list(connection, bucket, optional_params \\ [], opts \\ []) View Source

Retrieves a list of notification subscriptions for a given bucket.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a Google Cloud Storage bucket.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :provisionalUserProject (String.t): The project to be billed for this request if the target bucket is requester-pays bucket.
    • :userProject (String.t): The project to be billed for this request. Required for Requester Pays buckets.

Returns

{:ok, %GoogleApi.Storage.V1.Model.Notifications{}} on success {:error, info} on failure