Googly.CloudStorage.Notifications (googly_cloud_storage v0.1.0)

Copy Markdown View Source

Endpoints for the Notifications resource.

Summary

Functions

delete(bucket, notification, opts \\ [])

Permanently deletes a notification subscription.

get(bucket, notification, opts \\ [])

View a notification configuration.

insert(bucket, opts \\ [])

Creates a notification subscription for a given bucket.

list(bucket, opts \\ [])

Retrieves a list of notification subscriptions for a given bucket.

Functions

delete(bucket, notification, opts \\ [])

@spec delete(String.t(), String.t(), keyword()) ::
  {:ok, Req.Response.t()} | {:error, term()}

Permanently deletes a notification subscription.

Parameters

  • bucket (type: String.t()) - The parent bucket of the notification.
  • notification (type: String.t()) - ID of the notification to delete.
  • opts (type: keyword()) - Query and call options (:token, plus any of the below)
    • alt (type: String.t()) - Data format for the response.
    • fields (type: String.t()) - Selector specifying which fields to include in a partial response.
    • key (type: 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 (type: String.t()) - OAuth 2.0 token for the current user.
    • pretty_print (type: boolean()) - Returns response with indentations and line breaks.
    • quota_user (type: String.t()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • upload_type (type: String.t()) - Upload protocol for media (e.g. "media", "multipart", "resumable").
    • user_ip (type: String.t()) - Deprecated. Please use quotaUser instead.
    • user_project (type: String.t()) - The project to be billed for this request. Required for Requester Pays buckets.

Returns

  • {:ok, Req.Response.t()} on success
  • {:error, %Googly.CloudStorage.Error{}} on failure

get(bucket, notification, opts \\ [])

@spec get(String.t(), String.t(), keyword()) ::
  {:ok, Googly.CloudStorage.Model.Notification.t()} | {:error, term()}

View a notification configuration.

Parameters

  • bucket (type: String.t()) - The parent bucket of the notification.
  • notification (type: String.t()) - Notification ID
  • opts (type: keyword()) - Query and call options (:token, plus any of the below)
    • alt (type: String.t()) - Data format for the response.
    • fields (type: String.t()) - Selector specifying which fields to include in a partial response.
    • key (type: 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 (type: String.t()) - OAuth 2.0 token for the current user.
    • pretty_print (type: boolean()) - Returns response with indentations and line breaks.
    • quota_user (type: String.t()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • upload_type (type: String.t()) - Upload protocol for media (e.g. "media", "multipart", "resumable").
    • user_ip (type: String.t()) - Deprecated. Please use quotaUser instead.
    • user_project (type: String.t()) - The project to be billed for this request. Required for Requester Pays buckets.

Returns

  • {:ok, %Googly.CloudStorage.Model.Notification{}} on success
  • {:error, %Googly.CloudStorage.Error{}} on failure

insert(bucket, opts \\ [])

@spec insert(
  String.t(),
  keyword()
) :: {:ok, Googly.CloudStorage.Model.Notification.t()} | {:error, term()}

Creates a notification subscription for a given bucket.

Parameters

  • bucket (type: String.t()) - The parent bucket of the notification.
  • opts (type: keyword()) - Query and call options (:token, plus any of the below)
    • alt (type: String.t()) - Data format for the response.
    • fields (type: String.t()) - Selector specifying which fields to include in a partial response.
    • key (type: 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 (type: String.t()) - OAuth 2.0 token for the current user.
    • pretty_print (type: boolean()) - Returns response with indentations and line breaks.
    • quota_user (type: String.t()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • upload_type (type: String.t()) - Upload protocol for media (e.g. "media", "multipart", "resumable").
    • user_ip (type: String.t()) - Deprecated. Please use quotaUser instead.
    • user_project (type: String.t()) - The project to be billed for this request. Required for Requester Pays buckets.
    • body (type: Googly.CloudStorage.Model.Notification.t()) -

Returns

  • {:ok, %Googly.CloudStorage.Model.Notification{}} on success
  • {:error, %Googly.CloudStorage.Error{}} on failure

list(bucket, opts \\ [])

@spec list(
  String.t(),
  keyword()
) :: {:ok, Googly.CloudStorage.Model.Notifications.t()} | {:error, term()}

Retrieves a list of notification subscriptions for a given bucket.

Parameters

  • bucket (type: String.t()) - Name of a Google Cloud Storage bucket.
  • opts (type: keyword()) - Query and call options (:token, plus any of the below)
    • alt (type: String.t()) - Data format for the response.
    • fields (type: String.t()) - Selector specifying which fields to include in a partial response.
    • key (type: 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 (type: String.t()) - OAuth 2.0 token for the current user.
    • pretty_print (type: boolean()) - Returns response with indentations and line breaks.
    • quota_user (type: String.t()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • upload_type (type: String.t()) - Upload protocol for media (e.g. "media", "multipart", "resumable").
    • user_ip (type: String.t()) - Deprecated. Please use quotaUser instead.
    • user_project (type: String.t()) - The project to be billed for this request. Required for Requester Pays buckets.

Returns

  • {:ok, %Googly.CloudStorage.Model.Notifications{}} on success
  • {:error, %Googly.CloudStorage.Error{}} on failure