google_api_storage_transfer v0.5.0 GoogleApi.StorageTransfer.V1.Api.TransferJobs View Source
API calls for all endpoints tagged TransferJobs
.
Link to this section Summary
Functions
Creates a transfer job that runs periodically.
Gets a transfer job.
Lists transfer jobs.
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
storagetransfer_transfer_jobs_create(connection, optional_params \\ [], opts \\ []) View Source
Creates a transfer job that runs periodically.
Parameters
- connection (GoogleApi.StorageTransfer.V1.Connection): Connection to server
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 (TransferJob):
Returns
{:ok, %GoogleApi.StorageTransfer.V1.Model.TransferJob{}} on success {:error, info} on failure
storagetransfer_transfer_jobs_get(connection, job_name, optional_params \\ [], opts \\ []) View Source
Gets a transfer job.
Parameters
- connection (GoogleApi.StorageTransfer.V1.Connection): Connection to server
- job_name (String.t): The job to get. 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").
- :projectId (String.t): 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
storagetransfer_transfer_jobs_list(connection, optional_params \\ [], opts \\ []) View Source
Lists transfer jobs.
Parameters
- connection (GoogleApi.StorageTransfer.V1.Connection): Connection to server
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",...], "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`.
- :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.ListTransferJobsResponse{}} on success {:error, info} on failure
storagetransfer_transfer_jobs_patch(connection, job_name, optional_params \\ [], opts \\ []) View Source
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.t): The name of job to update. 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 (UpdateTransferJobRequest):
Returns
{:ok, %GoogleApi.StorageTransfer.V1.Model.TransferJob{}} on success {:error, info} on failure