- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
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 URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
The ID of the Cloud Platform project that the job belongs to. |
job |
The job ID. |
Query parameters
Parameters | |
---|---|
location |
The regional endpoint that contains this job. |
update |
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: |
Request body
The request body contains an instance of Job
.
Response body
If successful, the response body contains an instance of Job
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.