View Source GoogleApi.StorageTransfer.V1.Api.TransferJobs (google_api_storage_transfer v0.36.0)
API calls for all endpoints tagged TransferJobs
.
Summary
Functions
Creates a transfer job that runs periodically.
Deletes a transfer job. Deleting a transfer job sets its status to DELETED.
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. Note: The job's status field can be modified using this RPC (for example, to set a job's status to DELETED, DISABLED, or ENABLED).
Starts a new operation for the specified transfer job. A TransferJob
has a maximum of one active TransferOperation
. If this method is called while a TransferOperation
is active, an error is returned.
Functions
storagetransfer_transfer_jobs_create(connection, optional_params \\ [], opts \\ [])
View Source@spec storagetransfer_transfer_jobs_create(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.StorageTransfer.V1.Model.TransferJob.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a transfer job that runs periodically.
Parameters
-
connection
(type:GoogleApi.StorageTransfer.V1.Connection.t
) - Connection to server -
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.TransferJob.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.StorageTransfer.V1.Model.TransferJob{}}
on success -
{:error, info}
on failure
storagetransfer_transfer_jobs_delete(connection, job_name, project_id, optional_params \\ [], opts \\ [])
View Source@spec storagetransfer_transfer_jobs_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.StorageTransfer.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a transfer job. Deleting a transfer job sets its status to DELETED.
Parameters
-
connection
(type:GoogleApi.StorageTransfer.V1.Connection.t
) - Connection to server -
job_name
(type:String.t
) - Required. The job to delete. -
project_id
(type:String.t
) - Required. The ID of the Google Cloud project that owns the job. -
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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.StorageTransfer.V1.Model.Empty{}}
on success -
{:error, info}
on failure
storagetransfer_transfer_jobs_get(connection, job_name, project_id, optional_params \\ [], opts \\ [])
View Source@spec storagetransfer_transfer_jobs_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.StorageTransfer.V1.Model.TransferJob.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a transfer job.
Parameters
-
connection
(type:GoogleApi.StorageTransfer.V1.Connection.t
) - Connection to server -
job_name
(type:String.t
) - Required. The job to get. -
project_id
(type:String.t
) - Required. The ID of the Google Cloud project that owns the job. -
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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.StorageTransfer.V1.Model.TransferJob{}}
on success -
{:error, info}
on failure
storagetransfer_transfer_jobs_list(connection, filter, optional_params \\ [], opts \\ [])
View Source@spec storagetransfer_transfer_jobs_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.StorageTransfer.V1.Model.ListTransferJobsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists transfer jobs.
Parameters
-
connection
(type:GoogleApi.StorageTransfer.V1.Connection.t
) - Connection to server -
filter
(type:String.t
) - Required. A list of query parameters specified as JSON text in the form of:{"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobStatuses":["status1","status2",...]}
SincejobNames
andjobStatuses
support multiple values, their values must be specified with array notation.projectId
is required.jobNames
andjobStatuses
are optional. The valid values forjobStatuses
are case-insensitive: ENABLED, DISABLED, and DELETED. -
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"). -
: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@spec storagetransfer_transfer_jobs_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.StorageTransfer.V1.Model.TransferJob.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Note: The job's status field can be modified using this RPC (for example, to set a job's status to DELETED, DISABLED, or ENABLED).
Parameters
-
connection
(type:GoogleApi.StorageTransfer.V1.Connection.t
) - Connection to server -
job_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
storagetransfer_transfer_jobs_run(connection, job_name, optional_params \\ [], opts \\ [])
View Source@spec storagetransfer_transfer_jobs_run( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.StorageTransfer.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Starts a new operation for the specified transfer job. A TransferJob
has a maximum of one active TransferOperation
. If this method is called while a TransferOperation
is active, an error is returned.
Parameters
-
connection
(type:GoogleApi.StorageTransfer.V1.Connection.t
) - Connection to server -
job_name
(type:String.t
) - Required. The name of the transfer job. -
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.RunTransferJobRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.StorageTransfer.V1.Model.Operation{}}
on success -
{:error, info}
on failure