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

API calls for all endpoints tagged Notifications.

Link to this section Summary

Functions

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

Permanently deletes a notification subscription.

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

View a notification configuration.

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

Creates a notification subscription for a given bucket.

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

Retrieves a list of notification subscriptions for a given bucket.

Link to this section Functions

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

storage_notifications_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Permanently deletes a notification subscription.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - The parent bucket of the notification.
notification (type: String.t) - ID of the notification to delete.
optional_params (type: keyword()) - Optional parameters
- :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.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :provisionalUserProject (type: String.t) - The project to be billed for this request if the target bucket is requester-pays bucket.
- :userProject (type: String.t) - The project to be billed for this request. Required for Requester Pays buckets.
opts (type: keyword()) - Call options

Returns

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

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

storage_notifications_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.Notification.t()} | {:error, Tesla.Env.t()}

View a notification configuration.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - The parent bucket of the notification.
notification (type: String.t) - Notification ID
optional_params (type: keyword()) - Optional parameters
- :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.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :provisionalUserProject (type: String.t) - The project to be billed for this request if the target bucket is requester-pays bucket.
- :userProject (type: String.t) - The project to be billed for this request. Required for Requester Pays buckets.
opts (type: keyword()) - Call options

Returns

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

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

storage_notifications_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.Notification.t()} | {:error, Tesla.Env.t()}

Creates a notification subscription for a given bucket.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - The parent bucket of the notification.
optional_params (type: keyword()) - Optional parameters
- :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.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :provisionalUserProject (type: String.t) - The project to be billed for this request if the target bucket is requester-pays bucket.
- :userProject (type: String.t) - The project to be billed for this request. Required for Requester Pays buckets.
- :body (type: GoogleApi.Storage.V1.Model.Notification.t) -
opts (type: keyword()) - Call options

Returns

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

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

storage_notifications_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Storage.V1.Model.Notifications.t()} | {:error, Tesla.Env.t()}

Retrieves a list of notification subscriptions for a given bucket.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - Name of a Google Cloud Storage bucket.
optional_params (type: keyword()) - Optional parameters
- :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.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :provisionalUserProject (type: String.t) - The project to be billed for this request if the target bucket is requester-pays bucket.
- :userProject (type: String.t) - The project to be billed for this request. Required for Requester Pays buckets.
opts (type: keyword()) - Call options

Returns

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