Send feedback
Method: googleapis.cloudscheduler.v1beta1.projects.locations.jobs.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates a job. If successful, the updated Job is returned. If the job
does not exist, NOT_FOUND
is returned. If UpdateJob does not
successfully return, it is possible for the job to be in an
Job.State.UPDATE_FAILED state. A job in this state may not be executed.
If this happens, retry the UpdateJob request until a successful response
is received.
Arguments
Parameters
name
string
Required. Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
. * PROJECT_ID
can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects * LOCATION_ID
is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * JOB_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
updateMask
string (FieldMask format)
A mask used to specify which fields of the job are being updated.
body
object (Job )
Required.
Raised exceptions
Exceptions
ConnectionError
In case of a network problem (such as DNS failure or refused connection).
HttpError
If the response status is >= 400 (excluding 429 and 503).
TimeoutError
If a long-running operation takes longer to finish than the specified timeout limit.
TypeError
If an operation or function receives an argument of the wrong type.
ValueError
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
Response
If successful, the response contains an instance of Job
.
Subworkflow snippet
Some fields might be optional or required.
To identify required fields, refer to the API documentation .
YAML
- patch :
call : googleapis.cloudscheduler.v1beta1.projects.locations.jobs.patch
args :
name : ...
updateMask : ...
body :
appEngineHttpTarget :
appEngineRouting :
instance : ...
service : ...
version : ...
body : ...
httpMethod : ...
relativeUri : ...
attemptDeadline : ...
description : ...
httpTarget :
body : ...
headers : ...
httpMethod : ...
oauthToken :
scope : ...
serviceAccountEmail : ...
oidcToken :
audience : ...
serviceAccountEmail : ...
uri : ...
legacyAppEngineCron : ...
pubsubTarget :
attributes : ...
data : ...
topicName : ...
retryConfig :
maxBackoffDuration : ...
maxDoublings : ...
maxRetryDuration : ...
minBackoffDuration : ...
retryCount : ...
schedule : ...
timeZone : ...
result : patchResult
JSON
[
{
"patch" : {
"call" : "googleapis.cloudscheduler.v1beta1.projects.locations.jobs.patch" ,
"args" : {
"name" : "..." ,
"updateMask" : "..." ,
"body" : {
"appEngineHttpTarget" : {
"appEngineRouting" : {
"instance" : "..." ,
"service" : "..." ,
"version" : "..."
},
"body" : "..." ,
"httpMethod" : "..." ,
"relativeUri" : "..."
},
"attemptDeadline" : "..." ,
"description" : "..." ,
"httpTarget" : {
"body" : "..." ,
"headers" : "..." ,
"httpMethod" : "..." ,
"oauthToken" : {
"scope" : "..." ,
"serviceAccountEmail" : "..."
},
"oidcToken" : {
"audience" : "..." ,
"serviceAccountEmail" : "..."
},
"uri" : "..."
},
"legacyAppEngineCron" : "..." ,
"pubsubTarget" : {
"attributes" : "..." ,
"data" : "..." ,
"topicName" : "..."
},
"retryConfig" : {
"maxBackoffDuration" : "..." ,
"maxDoublings" : "..." ,
"maxRetryDuration" : "..." ,
"minBackoffDuration" : "..." ,
"retryCount" : "..."
},
"schedule" : "..." ,
"timeZone" : "..."
}
},
"result" : "patchResult"
}
}
]
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["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-09-04 UTC."],[],[],null,["# Method: googleapis.cloudscheduler.v1beta1.projects.locations.jobs.patch\n\nUpdates a job. If successful, the updated Job is returned. If the job\ndoes not exist, `NOT_FOUND` is returned. If UpdateJob does not\nsuccessfully return, it is possible for the job to be in an\nJob.State.UPDATE_FAILED state. A job in this state may not be executed.\nIf this happens, retry the UpdateJob request until a successful response\nis received.\n\nArguments\n---------\n\nRaised exceptions\n-----------------\n\nResponse\n--------\n\nIf successful, the response contains an instance of [`Job`](/workflows/docs/reference/googleapis/cloudscheduler/v1beta1/Overview#Job).\n\nSubworkflow snippet\n-------------------\n\nSome fields might be optional or required.\nTo identify required fields, refer to the [API documentation](https://cloud.google.com/scheduler/docs/reference/rest/v1beta1/projects.locations.jobs/patch). \n\n### YAML\n\n```yaml\n- patch:\n call: googleapis.cloudscheduler.v1beta1.projects.locations.jobs.patch\n args:\n name: ...\n updateMask: ...\n body:\n appEngineHttpTarget:\n appEngineRouting:\n instance: ...\n service: ...\n version: ...\n body: ...\n httpMethod: ...\n relativeUri: ...\n attemptDeadline: ...\n description: ...\n httpTarget:\n body: ...\n headers: ...\n httpMethod: ...\n oauthToken:\n scope: ...\n serviceAccountEmail: ...\n oidcToken:\n audience: ...\n serviceAccountEmail: ...\n uri: ...\n legacyAppEngineCron: ...\n pubsubTarget:\n attributes: ...\n data: ...\n topicName: ...\n retryConfig:\n maxBackoffDuration: ...\n maxDoublings: ...\n maxRetryDuration: ...\n minBackoffDuration: ...\n retryCount: ...\n schedule: ...\n timeZone: ...\n result: patchResult\n```\n\n### JSON\n\n```json\n[\n {\n \"patch\": {\n \"call\": \"googleapis.cloudscheduler.v1beta1.projects.locations.jobs.patch\",\n \"args\": {\n \"name\": \"...\",\n \"updateMask\": \"...\",\n \"body\": {\n \"appEngineHttpTarget\": {\n \"appEngineRouting\": {\n \"instance\": \"...\",\n \"service\": \"...\",\n \"version\": \"...\"\n },\n \"body\": \"...\",\n \"httpMethod\": \"...\",\n \"relativeUri\": \"...\"\n },\n \"attemptDeadline\": \"...\",\n \"description\": \"...\",\n \"httpTarget\": {\n \"body\": \"...\",\n \"headers\": \"...\",\n \"httpMethod\": \"...\",\n \"oauthToken\": {\n \"scope\": \"...\",\n \"serviceAccountEmail\": \"...\"\n },\n \"oidcToken\": {\n \"audience\": \"...\",\n \"serviceAccountEmail\": \"...\"\n },\n \"uri\": \"...\"\n },\n \"legacyAppEngineCron\": \"...\",\n \"pubsubTarget\": {\n \"attributes\": \"...\",\n \"data\": \"...\",\n \"topicName\": \"...\"\n },\n \"retryConfig\": {\n \"maxBackoffDuration\": \"...\",\n \"maxDoublings\": \"...\",\n \"maxRetryDuration\": \"...\",\n \"minBackoffDuration\": \"...\",\n \"retryCount\": \"...\"\n },\n \"schedule\": \"...\",\n \"timeZone\": \"...\"\n }\n },\n \"result\": \"patchResult\"\n }\n }\n]\n```"]]