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.
HTTP request
PUT https://dataflow.googleapis.com/v1b3/projects/{projectId}/jobs/{jobId}
The list of fields to update relative to Job. If empty, only RequestedJobState will be considered for update. If the FieldMask is not empty and RequestedJobState is none/empty, The fields specified in the update mask will be the only ones considered for update. If both RequestedJobState and updateMask are specified, an error will be returned as we cannot update both state and mask.
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
[[["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-04-30 UTC."],[[["\u003cp\u003eThis endpoint updates the state of an existing Cloud Dataflow job, and it is recommended to use the \u003ccode\u003eprojects.locations.jobs.update\u003c/code\u003e method with a regional endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a \u003ccode\u003ePUT\u003c/code\u003e method to a specific URL that includes the project ID and job ID as path parameters.\u003c/p\u003e\n"],["\u003cp\u003eRequired parameters for the request include \u003ccode\u003eprojectId\u003c/code\u003e and \u003ccode\u003ejobId\u003c/code\u003e as path parameters, and \u003ccode\u003elocation\u003c/code\u003e and \u003ccode\u003eupdateMask\u003c/code\u003e as query parameters, with \u003ccode\u003eupdateMask\u003c/code\u003e allowing specific field updates.\u003c/p\u003e\n"],["\u003cp\u003eThe request body and successful response body both utilize the \u003ccode\u003eJob\u003c/code\u003e resource type, and the update operation is performed on it.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires either the \u003ccode\u003ehttps://www.googleapis.com/auth/compute\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.jobs.update\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\nUpdates the state of an existing Cloud Dataflow job.\n\nTo update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regional endpoint](https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.update` is not recommended, as you can only update the state of jobs that are running in `us-central1`.\n\n### HTTP request\n\n`PUT https://dataflow.googleapis.com/v1b3/projects/{projectId}/jobs/{jobId}`\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](/dataflow/docs/reference/rest/v1b3/projects.jobs#Job).\n\n### Response body\n\nIf successful, the response body contains an instance of [Job](/dataflow/docs/reference/rest/v1b3/projects.jobs#Job).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/compute`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
