Method: projects.locations.jobs.patch

Update a Job.

HTTP request

PATCH https://batch.googleapis.com/v1alpha/{job.name=projects/*/locations/*/jobs/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
job.name

string

Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Mask of fields to update.

The jobs.patch method can only be used while a job is in the QUEUED, SCHEDULED, or RUNNING state and currently only supports increasing the value of the first taskCount field in the job's taskGroups field. Therefore, you must set the value of updateMask to taskGroups. Any other job fields in the update request will be ignored.

For example, to update a job's taskCount to 2, set updateMask to taskGroups and use the following request body:

{
  "taskGroups":[{
    "taskCount": 2
  }]
}

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
requestId

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

The request body contains an instance of Job.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.