Updates a Job.
This method waits—the workflow execution is paused—until the operation is
complete, fails, or times out. The default timeout value is 1800 seconds (30
minutes) and can be changed to a maximum value of 31536000 seconds (one year)
for long-running operations using the connector_params field. See the
Connectors reference.
The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.
The polling policy for the long-running operation can be configured. To set the
connector-specific parameters (connector_params), refer to
Invoke a connector call.
Arguments
| Parameters | |
|---|---|
name |
Required. The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job} |
allowMissing |
Optional. If set to true, and if the Job does not exist, it will create a new one. Caller must have both create and update permissions for this call if this is set to true. |
validateOnly |
Indicates that the request should be validated and default values populated, without persisting the request or updating any resources. |
body |
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. |
OperationError |
If the long-running operation finished unsuccessfully. |
ResponseTypeError |
If the long-running operation returned a response of the wrong type. |
Response
If successful, the response contains an instance of GoogleLongrunningOperation.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- patch: call: googleapis.run.v2.projects.locations.jobs.patch args: name: ... allowMissing: ... validateOnly: ... body: annotations: ... binaryAuthorization: breakglassJustification: ... policy: ... useDefault: ... client: ... clientVersion: ... labels: ... launchStage: ... name: ... runExecutionToken: ... startExecutionToken: ... template: annotations: ... labels: ... parallelism: ... taskCount: ... template: containers: ... encryptionKey: ... executionEnvironment: ... maxRetries: ... serviceAccount: ... timeout: ... volumes: ... vpcAccess: connector: ... egress: ... networkInterfaces: ... result: patchResult
JSON
[ { "patch": { "call": "googleapis.run.v2.projects.locations.jobs.patch", "args": { "name": "...", "allowMissing": "...", "validateOnly": "...", "body": { "annotations": "...", "binaryAuthorization": { "breakglassJustification": "...", "policy": "...", "useDefault": "..." }, "client": "...", "clientVersion": "...", "labels": "...", "launchStage": "...", "name": "...", "runExecutionToken": "...", "startExecutionToken": "...", "template": { "annotations": "...", "labels": "...", "parallelism": "...", "taskCount": "...", "template": { "containers": "...", "encryptionKey": "...", "executionEnvironment": "...", "maxRetries": "...", "serviceAccount": "...", "timeout": "...", "volumes": "...", "vpcAccess": { "connector": "...", "egress": "...", "networkInterfaces": "..." } } } } }, "result": "patchResult" } } ]