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

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
jobName

string

The name of job to update. Required.

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
}
Fields
project_id

string

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

transfer_job

object(TransferJob)

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

update_transfer_job_field_mask

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:

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

For more information, see the Authentication Overview.

Hat Ihnen diese Seite weitergeholfen? Teilen Sie uns Ihr Feedback mit:

Feedback geben zu...

Cloud Storage Transfer Service