google_api_storage_transfer

v0.2.0

google_api_storage_transfer v0.2.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_delete(connection, name, optional_params \\ [], opts \\ [])

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

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_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

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.t): The name of the operation resource to be cancelled.

  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").

Returns

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

Link to this function storagetransfer_transfer_operations_delete(connection, name, optional_params \\ [], opts \\ []) View Source

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

Parameters

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

  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").

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

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.t): The name of the operation resource.

  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :filter (String.t): A list of query parameters specified as JSON text in the form of {\"project_id\" : \"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. `job_names`, `operation_names`, and `transfer_statuses` are optional.
    • :pageSize (integer()): The list page size. The max allowed value is 256.
    • :pageToken (String.t): The list page token.

Returns

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

Link to this function storagetransfer_transfer_operations_pause(connection, name, optional_params \\ [], opts \\ []) View Source

Pauses a transfer operation.

Parameters

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

  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :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, optional_params \\ [], opts \\ []) View Source

Resumes a transfer operation that is paused.

Parameters

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

  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (ResumeTransferOperationRequest):

Returns

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