Method: transferJobs.patch

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.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The name of job to update.

Request body

The request body contains data with the following structure:

JSON representation
  "project_id": string,
  "transfer_job": {
    object (TransferJob)
  "update_transfer_job_field_mask": string


Required. The ID of the Google Cloud Platform Console project that owns the job.


object (TransferJob)

Required. The job to update. transferJob is expected to specify only three fields: description, transferSpec, and status. An UpdateTransferJobRequest that specifies other fields will be rejected with an error INVALID_ARGUMENT.


string (FieldMask format)

The field mask of the fields in transferJob that are to be updated in this request. Fields in transferJob that can be updated are: description, transferSpec, and status. To update the transferSpec of the job, a complete transfer specification has to be provided. An incomplete specification which misses any required fields will be rejected with the error INVALID_ARGUMENT.

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Response body

If successful, the response body contains an instance of TransferJob.

Authorization Scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

Hai trovato utile questa pagina? Facci sapere cosa ne pensi:

Invia feedback per...

Cloud Storage Transfer Service