View Source GoogleApi.Storage.V1.Api.Operations (google_api_storage v0.43.0)

API calls for all endpoints tagged Operations.

Summary

Functions

storage_buckets_operations_cancel(connection, bucket, operation_id, optional_params \\ [], opts \\ [])

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.

storage_buckets_operations_get(connection, bucket, operation_id, optional_params \\ [], opts \\ [])

Gets the latest state of a long-running operation.

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

Lists operations that match the specified filter in the request.

Functions

storage_buckets_operations_cancel(connection, bucket, operation_id, optional_params \\ [], opts \\ [])

@spec storage_buckets_operations_cancel(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - The parent bucket of the operation resource.
operation_id (type: String.t) - The ID of the operation resource.
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.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
opts (type: keyword()) - Call options

Returns

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

storage_buckets_operations_get(connection, bucket, operation_id, optional_params \\ [], opts \\ [])

@spec storage_buckets_operations_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the latest state of a long-running operation.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - The parent bucket of the operation resource.
operation_id (type: String.t) - The ID of the operation resource.
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.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
opts (type: keyword()) - Call options

Returns

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

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

@spec storage_buckets_operations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.GoogleLongrunningListOperationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists operations that match the specified filter in the request.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - Name of the bucket in which to look for operations.
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.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :filter (type: String.t) - A filter to narrow down results to a preferred subset. The filtering language is documented in more detail in AIP-160.
- :pageSize (type: integer()) - Maximum number of items to return in a single page of responses. Fewer total results may be returned than requested. The service uses this parameter or 100 items, whichever is smaller.
- :pageToken (type: String.t) - A previously-returned page token representing part of the larger set of results to view.
opts (type: keyword()) - Call options

Returns

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