google_api_storage_transfer

v0.0.1

google_api_storage_transfer v0.0.1 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, opts \\ [])

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

storagetransfer_transfer_operations_delete(connection, name, opts \\ [])

This method is not supported and the server returns `UNIMPLEMENTED`

storagetransfer_transfer_operations_get(connection, name, 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_pause(connection, name, opts \\ [])

Pauses a transfer operation

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

Resumes a transfer operation that is paused

Link to this section Functions

Link to this function storagetransfer_transfer_operations_cancel(connection, name, opts \\ []) View Source 
storagetransfer_transfer_operations_cancel(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.StorageTransfer.V1.Model.Empty.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 (GoogleApi.StorageTransfer.V1.Connection): Connection to server
  • name (String): The name of the operation resource to be cancelled.

  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.

Returns

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

Link to this function storagetransfer_transfer_operations_delete(connection, name, opts \\ []) View Source 
storagetransfer_transfer_operations_delete(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.StorageTransfer.V1.Model.Empty.t} |
  {:error, Tesla.Env.t}

This method is not supported and the server returns `UNIMPLEMENTED`.

Parameters

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

  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.

Returns

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

Link to this function storagetransfer_transfer_operations_get(connection, name, opts \\ []) View Source 
storagetransfer_transfer_operations_get(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.StorageTransfer.V1.Model.Operation.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 (GoogleApi.StorageTransfer.V1.Connection): Connection to server
  • name (String): The name of the operation resource.

  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.

Returns

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

Link to this function storagetransfer_transfer_operations_pause(connection, name, opts \\ []) View Source 
storagetransfer_transfer_operations_pause(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.StorageTransfer.V1.Model.Empty.t} |
  {:error, Tesla.Env.t}

Pauses a transfer operation.

Parameters

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

  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :body (PauseTransferOperationRequest):

Returns

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

Link to this function storagetransfer_transfer_operations_resume(connection, name, opts \\ []) View Source 
storagetransfer_transfer_operations_resume(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.StorageTransfer.V1.Model.Empty.t} |
  {:error, Tesla.Env.t}

Resumes a transfer operation that is paused.

Parameters

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

  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :body (ResumeTransferOperationRequest):

Returns

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