Thejobs.patchmethod can only be used while a job is in theQUEUED,SCHEDULED, orRUNNINGstate and currently only supports increasing the value of the firsttaskCountfield in the job'staskGroupsfield. Therefore, you must set the value ofupdateMasktotaskGroups. Any other job fields in the update request will be ignored.
For example, to update a job'staskCountto2, setupdateMasktotaskGroupsand 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).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-09 UTC."],[[["\u003cp\u003eThis webpage details how to update a job using a PATCH HTTP request to the Google Batch API.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ejob.name\u003c/code\u003e path parameter is a required string that uniquely identifies the job being updated, and it has the format of \u003ccode\u003eprojects/*/locations/*/jobs/*\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eupdateMask\u003c/code\u003e query parameter, set to \u003ccode\u003etaskGroups\u003c/code\u003e, is required to modify the \u003ccode\u003etaskCount\u003c/code\u003e field in a job's \u003ccode\u003etaskGroups\u003c/code\u003e, allowing the adjustment of task counts for jobs in \u003ccode\u003eQUEUED\u003c/code\u003e, \u003ccode\u003eSCHEDULED\u003c/code\u003e, or \u003ccode\u003eRUNNING\u003c/code\u003e states.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003erequestId\u003c/code\u003e query parameter can be used to ensure idempotency by providing a unique identifier for each request, preventing duplicate actions upon retries.\u003c/p\u003e\n"],["\u003cp\u003eThe request and response bodies both utilize the \u003ccode\u003eJob\u003c/code\u003e resource, as defined in the Batch API reference.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.jobs.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdate a Job.\n\n### HTTP request\n\n`PATCH https://batch.googleapis.com/v1alpha/{job.name=projects/*/locations/*/jobs/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [Job](/batch/docs/reference/rest/v1alpha/projects.locations.jobs#Job).\n\n### Response body\n\nIf successful, the response body contains an instance of [Job](/batch/docs/reference/rest/v1alpha/projects.locations.jobs#Job).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
