Send feedback
Method: googleapis.dataflow.v1b3.projects.locations.jobs.update
Stay organized with collections
Save and categorize content based on your preferences.
Updates the state of an existing Cloud Dataflow job. To update the state
of an existing job, we recommend using projects.locations.jobs.update
with a regional endpoint .
Using projects.jobs.update
is not recommended, as you can only update
the state of jobs that are running in us-central1
.
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
jobId
string
Required. The job ID.
location
string
Required. The regional endpoint that contains this job.
projectId
string
Required. The ID of the Cloud Platform project that the job belongs to.
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.
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 Job
.
Subworkflow snippet
Some fields might be optional or required.
To identify required fields, refer to the API documentation .
YAML
- update :
call : googleapis.dataflow.v1b3.projects.locations.jobs.update
args :
jobId : ...
location : ...
projectId : ...
body :
clientRequestId : ...
createTime : ...
createdFromSnapshotId : ...
currentState : ...
currentStateTime : ...
environment :
clusterManagerApiService : ...
dataset : ...
debugOptions :
enableHotKeyLogging : ...
experiments : ...
flexResourceSchedulingGoal : ...
internalExperiments : ...
sdkPipelineOptions : ...
serviceAccountEmail : ...
serviceKmsKeyName : ...
serviceOptions : ...
tempStoragePrefix : ...
userAgent : ...
version : ...
workerPools : ...
workerRegion : ...
workerZone : ...
executionInfo :
stages : ...
id : ...
jobMetadata :
bigTableDetails : ...
bigqueryDetails : ...
datastoreDetails : ...
fileDetails : ...
pubsubDetails : ...
sdkVersion :
sdkSupportStatus : ...
version : ...
versionDisplayName : ...
spannerDetails : ...
labels : ...
location : ...
name : ...
pipelineDescription :
displayData : ...
executionPipelineStage : ...
originalPipelineTransform : ...
projectId : ...
replaceJobId : ...
replacedByJobId : ...
requestedState : ...
satisfiesPzs : ...
stageStates : ...
startTime : ...
steps : ...
stepsLocation : ...
tempFiles : ...
transformNameMapping : ...
type : ...
result : updateResult
JSON
[
{
"update" : {
"call" : "googleapis.dataflow.v1b3.projects.locations.jobs.update" ,
"args" : {
"jobId" : "..." ,
"location" : "..." ,
"projectId" : "..." ,
"body" : {
"clientRequestId" : "..." ,
"createTime" : "..." ,
"createdFromSnapshotId" : "..." ,
"currentState" : "..." ,
"currentStateTime" : "..." ,
"environment" : {
"clusterManagerApiService" : "..." ,
"dataset" : "..." ,
"debugOptions" : {
"enableHotKeyLogging" : "..."
},
"experiments" : "..." ,
"flexResourceSchedulingGoal" : "..." ,
"internalExperiments" : "..." ,
"sdkPipelineOptions" : "..." ,
"serviceAccountEmail" : "..." ,
"serviceKmsKeyName" : "..." ,
"serviceOptions" : "..." ,
"tempStoragePrefix" : "..." ,
"userAgent" : "..." ,
"version" : "..." ,
"workerPools" : "..." ,
"workerRegion" : "..." ,
"workerZone" : "..."
},
"executionInfo" : {
"stages" : "..."
},
"id" : "..." ,
"jobMetadata" : {
"bigTableDetails" : "..." ,
"bigqueryDetails" : "..." ,
"datastoreDetails" : "..." ,
"fileDetails" : "..." ,
"pubsubDetails" : "..." ,
"sdkVersion" : {
"sdkSupportStatus" : "..." ,
"version" : "..." ,
"versionDisplayName" : "..."
},
"spannerDetails" : "..."
},
"labels" : "..." ,
"location" : "..." ,
"name" : "..." ,
"pipelineDescription" : {
"displayData" : "..." ,
"executionPipelineStage" : "..." ,
"originalPipelineTransform" : "..."
},
"projectId" : "..." ,
"replaceJobId" : "..." ,
"replacedByJobId" : "..." ,
"requestedState" : "..." ,
"satisfiesPzs" : "..." ,
"stageStates" : "..." ,
"startTime" : "..." ,
"steps" : "..." ,
"stepsLocation" : "..." ,
"tempFiles" : "..." ,
"transformNameMapping" : "..." ,
"type" : "..."
}
},
"result" : "updateResult"
}
}
]
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.dataflow.v1b3.projects.locations.jobs.update\n\nUpdates the state of an existing Cloud Dataflow job. To update the state\nof an existing job, we recommend using `projects.locations.jobs.update`\nwith a [regional endpoint](https://cloud.google.com/dataflow/docs/concepts/regional-endpoints).\nUsing `projects.jobs.update` is not recommended, as you can only update\nthe state of jobs that are running in `us-central1`.\n\nThis method waits---the workflow execution is paused---until the operation is\ncomplete, fails, or times out. The default timeout value is `1800` seconds (30\nminutes) and can be changed to a maximum value of `31536000` seconds (one year)\nfor long-running operations using the `connector_params` field. See the\n[Connectors reference](/workflows/docs/reference/googleapis).\n\nThe connector uses polling to monitor the long-running operation, which might\ngenerate additional billable steps. For more information about retries and\nlong-running operations, refer to [Understand connectors](/workflows/docs/connectors).\n\nThe polling policy for the long-running operation can be configured. To set the\nconnector-specific parameters (`connector_params`), refer to\n[Invoke a connector call](/workflows/docs/reference/googleapis#invoke_a_connector_call).\n\nArguments\n---------\n\nRaised exceptions\n-----------------\n\nResponse\n--------\n\nIf successful, the response contains an instance of [`Job`](/workflows/docs/reference/googleapis/dataflow/v1b3/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/dataflow/docs/reference/rest/v1b3/projects.locations.jobs/update). \n\n### YAML\n\n```yaml\n- update:\n call: googleapis.dataflow.v1b3.projects.locations.jobs.update\n args:\n jobId: ...\n location: ...\n projectId: ...\n body:\n clientRequestId: ...\n createTime: ...\n createdFromSnapshotId: ...\n currentState: ...\n currentStateTime: ...\n environment:\n clusterManagerApiService: ...\n dataset: ...\n debugOptions:\n enableHotKeyLogging: ...\n experiments: ...\n flexResourceSchedulingGoal: ...\n internalExperiments: ...\n sdkPipelineOptions: ...\n serviceAccountEmail: ...\n serviceKmsKeyName: ...\n serviceOptions: ...\n tempStoragePrefix: ...\n userAgent: ...\n version: ...\n workerPools: ...\n workerRegion: ...\n workerZone: ...\n executionInfo:\n stages: ...\n id: ...\n jobMetadata:\n bigTableDetails: ...\n bigqueryDetails: ...\n datastoreDetails: ...\n fileDetails: ...\n pubsubDetails: ...\n sdkVersion:\n sdkSupportStatus: ...\n version: ...\n versionDisplayName: ...\n spannerDetails: ...\n labels: ...\n location: ...\n name: ...\n pipelineDescription:\n displayData: ...\n executionPipelineStage: ...\n originalPipelineTransform: ...\n projectId: ...\n replaceJobId: ...\n replacedByJobId: ...\n requestedState: ...\n satisfiesPzs: ...\n stageStates: ...\n startTime: ...\n steps: ...\n stepsLocation: ...\n tempFiles: ...\n transformNameMapping: ...\n type: ...\n result: updateResult\n```\n\n### JSON\n\n```json\n[\n {\n \"update\": {\n \"call\": \"googleapis.dataflow.v1b3.projects.locations.jobs.update\",\n \"args\": {\n \"jobId\": \"...\",\n \"location\": \"...\",\n \"projectId\": \"...\",\n \"body\": {\n \"clientRequestId\": \"...\",\n \"createTime\": \"...\",\n \"createdFromSnapshotId\": \"...\",\n \"currentState\": \"...\",\n \"currentStateTime\": \"...\",\n \"environment\": {\n \"clusterManagerApiService\": \"...\",\n \"dataset\": \"...\",\n \"debugOptions\": {\n \"enableHotKeyLogging\": \"...\"\n },\n \"experiments\": \"...\",\n \"flexResourceSchedulingGoal\": \"...\",\n \"internalExperiments\": \"...\",\n \"sdkPipelineOptions\": \"...\",\n \"serviceAccountEmail\": \"...\",\n \"serviceKmsKeyName\": \"...\",\n \"serviceOptions\": \"...\",\n \"tempStoragePrefix\": \"...\",\n \"userAgent\": \"...\",\n \"version\": \"...\",\n \"workerPools\": \"...\",\n \"workerRegion\": \"...\",\n \"workerZone\": \"...\"\n },\n \"executionInfo\": {\n \"stages\": \"...\"\n },\n \"id\": \"...\",\n \"jobMetadata\": {\n \"bigTableDetails\": \"...\",\n \"bigqueryDetails\": \"...\",\n \"datastoreDetails\": \"...\",\n \"fileDetails\": \"...\",\n \"pubsubDetails\": \"...\",\n \"sdkVersion\": {\n \"sdkSupportStatus\": \"...\",\n \"version\": \"...\",\n \"versionDisplayName\": \"...\"\n },\n \"spannerDetails\": \"...\"\n },\n \"labels\": \"...\",\n \"location\": \"...\",\n \"name\": \"...\",\n \"pipelineDescription\": {\n \"displayData\": \"...\",\n \"executionPipelineStage\": \"...\",\n \"originalPipelineTransform\": \"...\"\n },\n \"projectId\": \"...\",\n \"replaceJobId\": \"...\",\n \"replacedByJobId\": \"...\",\n \"requestedState\": \"...\",\n \"satisfiesPzs\": \"...\",\n \"stageStates\": \"...\",\n \"startTime\": \"...\",\n \"steps\": \"...\",\n \"stepsLocation\": \"...\",\n \"tempFiles\": \"...\",\n \"transformNameMapping\": \"...\",\n \"type\": \"...\"\n }\n },\n \"result\": \"updateResult\"\n }\n }\n]\n```"]]