google_api_storage_transfer

v0.0.1

google_api_storage_transfer v0.0.1 GoogleApi.StorageTransfer.V1.Api.TransferJobs View Source

API calls for all endpoints tagged TransferJobs.

Link to this section Summary

Functions

storagetransfer_transfer_jobs_create(connection, opts \\ [])

Creates a transfer job that runs periodically

storagetransfer_transfer_jobs_get(connection, job_name, opts \\ [])

Gets a transfer job

storagetransfer_transfer_jobs_list(connection, opts \\ [])

Lists transfer jobs

storagetransfer_transfer_jobs_patch(connection, job_name, opts \\ [])

Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating the scheduling of a job is not allowed

Link to this section Functions

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

Creates a transfer job that runs periodically.

Parameters

  • connection (GoogleApi.StorageTransfer.V1.Connection): Connection to server

  • 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 (TransferJob):

Returns

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

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

Gets a transfer job.

Parameters

  • connection (GoogleApi.StorageTransfer.V1.Connection): Connection to server
  • job_name (String): The job to get. 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.
    • :project_id (String): The ID of the Google Cloud Platform Console project that owns the job. Required.

Returns

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

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

Lists transfer jobs.

Parameters

  • connection (GoogleApi.StorageTransfer.V1.Connection): Connection to server

  • 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.
    • :page_token (String): The list page token.
    • :page_size (Integer): The list page size. The max allowed value is 256.
    • :filter (String): A list of query parameters specified as JSON text in the form of {"project_id":"my_project_id", "job_names":["jobid1","jobid2",…], "job_statuses":["status1","status2",…]}. Since `job_names` and `job_statuses` support multiple values, their values must be specified with array notation. `project_id` is required. `job_names` and `job_statuses` are optional. The valid values for `job_statuses` are case-insensitive: `ENABLED`, `DISABLED`, and `DELETED`.

Returns

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

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

Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating the scheduling of a job is not allowed.

Parameters

  • connection (GoogleApi.StorageTransfer.V1.Connection): Connection to server
  • job_name (String): The name of job to update. 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 (UpdateTransferJobRequest):

Returns

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