Method: transferJobs.patch

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).

HTTP request

PATCH https://storagetransfer.googleapis.com/v1/{jobName=transferJobs/**}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
jobName

string

Required. The name of job to update.

Authorization requires the following IAM permission on the specified resource jobName:

  • storagetransfer.jobs.update

Request body

The request body contains data with the following structure:

JSON representation
{
  "projectId": string,
  "transferJob": {
    object (TransferJob)
  },
  "updateTransferJobFieldMask": string
}
Fields
projectId

string

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

transferJob

object (TransferJob)

Required. The job to update. transferJob is expected to specify only four fields: description, transferSpec, notificationConfig, and status. An UpdateTransferJobRequest that specifies other fields will be rejected with the error INVALID_ARGUMENT. Updating a job satus to [DELETED][TransferJob.status.DELETED] requires storagetransfer.jobs.delete permissions.

updateTransferJobFieldMask

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, notificationConfig, and status. To update the transferSpec of the job, a complete transfer specification must be provided. An incomplete specification missing 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:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.