google_api_storage_transfer

v0.18.0

google_api_storage_transfer v0.18.0 GoogleApi.StorageTransfer.V1.Api.TransferOperations View Source

API calls for all endpoints tagged TransferOperations.

Link to this section Summary

Functions

storagetransfer_transfer_operations_cancel(connection, name, optional_params \\ [], opts \\ [])

Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.

storagetransfer_transfer_operations_get(connection, name, optional_params \\ [], opts \\ [])

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

storagetransfer_transfer_operations_list(connection, name, optional_params \\ [], opts \\ [])

Lists transfer operations.

storagetransfer_transfer_operations_pause(connection, name, optional_params \\ [], opts \\ [])

Pauses a transfer operation.

storagetransfer_transfer_operations_resume(connection, name, optional_params \\ [], opts \\ [])

Resumes a transfer operation that is paused.

Link to this section Functions

Link to this function

storagetransfer_transfer_operations_cancel(connection, name, optional_params \\ [], opts \\ [])

View Source 
storagetransfer_transfer_operations_cancel(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.StorageTransfer.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.

Parameters

  • connection (type: GoogleApi.StorageTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - The name of the operation resource to be cancelled.

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.StorageTransfer.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

storagetransfer_transfer_operations_get(connection, name, optional_params \\ [], opts \\ [])

View Source 
storagetransfer_transfer_operations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.StorageTransfer.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters

  • connection (type: GoogleApi.StorageTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - The name of the operation resource.

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.StorageTransfer.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

storagetransfer_transfer_operations_list(connection, name, optional_params \\ [], opts \\ [])

View Source 
storagetransfer_transfer_operations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.StorageTransfer.V1.Model.ListOperationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Lists transfer operations.

Parameters

  • connection (type: GoogleApi.StorageTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The value transferOperations.

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Required. A list of query parameters specified as JSON text in the form of: {"projectid":"my_project_id", "job_names":["jobid1","jobid2",...], "operation_names":["opid1","opid2",...], "transfer_statuses":["status1","status2",...]}. Since job_names, operation_names, and transfer_statuses support multiple values, they must be specified with array notation. project`</span>idis required.job_names,operation_names, andtransfer_statusesare optional. The valid values fortransfer_statuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED.
    • :pageSize (type: integer()) - The list page size. The max allowed value is 256.
    • :pageToken (type: String.t) - The list page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.StorageTransfer.V1.Model.ListOperationsResponse{}} on success
  • {:error, info} on failure
Link to this function

storagetransfer_transfer_operations_pause(connection, name, optional_params \\ [], opts \\ [])

View Source 
storagetransfer_transfer_operations_pause(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.StorageTransfer.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Pauses a transfer operation.

Parameters

  • connection (type: GoogleApi.StorageTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the transfer operation.

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.StorageTransfer.V1.Model.PauseTransferOperationRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.StorageTransfer.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

storagetransfer_transfer_operations_resume(connection, name, optional_params \\ [], opts \\ [])

View Source 
storagetransfer_transfer_operations_resume(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.StorageTransfer.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Resumes a transfer operation that is paused.

Parameters

  • connection (type: GoogleApi.StorageTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the transfer operation.

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.StorageTransfer.V1.Model.ResumeTransferOperationRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.StorageTransfer.V1.Model.Empty{}} on success
  • {:error, info} on failure