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 |
Required. The name of job to update. Authorization requires the following IAM permission on the specified resource
|
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"projectId": string,
"transferJob": {
object ( |
Fields | |
---|---|
projectId |
Required. The ID of the Google Cloud project that owns the job. |
transferJob |
Required. The job to update. |
updateTransferJobFieldMask |
The field mask of the fields in This is a comma-separated list of fully qualified names of fields. Example: |
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.