google_api_storage_transfer v0.6.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
storagetransfer_transfer_jobs_create(Tesla.Env.client(), keyword(), keyword()) ::
{:ok, GoogleApi.StorageTransfer.V1.Model.TransferJob.t()}
| {:error, Tesla.Env.t()}
storagetransfer_transfer_jobs_create(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.StorageTransfer.V1.Model.TransferJob.t()} | {:error, Tesla.Env.t()}
Creates a transfer job that runs periodically.
Parameters
connection
(type:GoogleApi.StorageTransfer.V1.Connection.t
) - Connection to serveroptional_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.TransferJob.t
) -
opts
(type:keyword()
) - Call options
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
storagetransfer_transfer_jobs_get(
Tesla.Env.client(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.StorageTransfer.V1.Model.TransferJob.t()}
| {:error, Tesla.Env.t()}
storagetransfer_transfer_jobs_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.StorageTransfer.V1.Model.TransferJob.t()} | {:error, Tesla.Env.t()}
Gets a transfer job.
Parameters
connection
(type:GoogleApi.StorageTransfer.V1.Connection.t
) - Connection to serverjob_name
(type:String.t
) - Required. The job to get.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").:projectId
(type:String.t
) - Required. The ID of the Google Cloud Platform Console project that owns the job.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.StorageTransfer.V1.Model.TransferJob{}}
on success{:error, info}
on failure
storagetransfer_transfer_jobs_list(connection, optional_params \\ [], opts \\ [])
View Source
storagetransfer_transfer_jobs_list(Tesla.Env.client(), keyword(), keyword()) ::
{:ok, GoogleApi.StorageTransfer.V1.Model.ListTransferJobsResponse.t()}
| {:error, Tesla.Env.t()}
storagetransfer_transfer_jobs_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.StorageTransfer.V1.Model.ListTransferJobsResponse.t()} | {:error, Tesla.Env.t()}
Lists transfer jobs.
Parameters
connection
(type:GoogleApi.StorageTransfer.V1.Connection.t
) - Connection to serveroptional_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: {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "job_statuses":["status1","status2",...]}. Sincejob_names
andjob_statuses
support multiple values, their values must be specified with array notation.project_id
is required.job_names
andjob_statuses
are optional. The valid values forjob_statuses
are case-insensitive:ENABLED
,DISABLED
, andDELETED
.: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.ListTransferJobsResponse{}}
on success{:error, info}
on failure
storagetransfer_transfer_jobs_patch(connection, job_name, optional_params \\ [], opts \\ [])
View Source
storagetransfer_transfer_jobs_patch(
Tesla.Env.client(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.StorageTransfer.V1.Model.TransferJob.t()}
| {:error, Tesla.Env.t()}
storagetransfer_transfer_jobs_patch( Tesla.Env.client(), String.t(), keyword(), 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
(type:GoogleApi.StorageTransfer.V1.Connection.t
) - Connection to serverjob_name
(type:String.t
) - Required. The name of job to update.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.UpdateTransferJobRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.StorageTransfer.V1.Model.TransferJob{}}
on success{:error, info}
on failure