Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1342194234.5 KB
projects

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] (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.

put/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}

Path parameters

projectIdstring required

The ID of the Cloud Platform project that the job belongs to.

locationstring required

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

jobIdstring required

The job ID.

Query parameters

updateMaskstring

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 update_mask are specified, an error will be returned as we cannot update both state and mask.

Request body

createTimestring google-datetime

The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

labelsobject

User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.

replacedByJobIdstring

If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field contains the ID of that job.

createdFromSnapshotIdstring

If this is specified, the job's initial state is populated from the given snapshot.

clientRequestIdstring

The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.

pausableboolean

Output only. Indicates whether the job can be paused.

currentStateTimestring google-datetime

The timestamp associated with the current state.

satisfiesPzsboolean

Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.

transformNameMappingobject

Optional. The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

projectIdstring

The ID of the Google Cloud project that the job belongs to.

stepsLocationstring

The Cloud Storage location where the steps are stored.

locationstring

Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

tempFilesstring[]

A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

replaceJobIdstring

If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a CreateJobRequest, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.

startTimestring google-datetime

The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service.

type'JOB_TYPE_UNKNOWN' | 'JOB_TYPE_BATCH' | 'JOB_TYPE_STREAMING'

Optional. The type of Dataflow job.

currentState'JOB_STATE_UNKNOWN' | 'JOB_STATE_STOPPED' | 'JOB_STATE_RUNNING' | 'JOB_STATE_DONE' | 'JOB_STATE_FAILED' | 'JOB_STATE_CANCELLED' | 'JOB_STATE_UPDATED' | 'JOB_STATE_DRAINING' | 'JOB_STATE_DRAINED' | 'JOB_STATE_PENDING' | 'JOB_STATE_CANCELLING' | 'JOB_STATE_QUEUED' | 'JOB_STATE_RESOURCE_CLEANING_UP' | 'JOB_STATE_PAUSING' | 'JOB_STATE_PAUSED'

The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field might be mutated by the Dataflow service; callers cannot mutate it.

requestedState'JOB_STATE_UNKNOWN' | 'JOB_STATE_STOPPED' | 'JOB_STATE_RUNNING' | 'JOB_STATE_DONE' | 'JOB_STATE_FAILED' | 'JOB_STATE_CANCELLED' | 'JOB_STATE_UPDATED' | 'JOB_STATE_DRAINING' | 'JOB_STATE_DRAINED' | 'JOB_STATE_PENDING' | 'JOB_STATE_CANCELLING' | 'JOB_STATE_QUEUED' | 'JOB_STATE_RESOURCE_CLEANING_UP' | 'JOB_STATE_PAUSING' | 'JOB_STATE_PAUSED'

The job's requested state. Applies to UpdateJob requests. Set requested_state with UpdateJob requests to switch between the states JOB_STATE_STOPPED and JOB_STATE_RUNNING. You can also use UpdateJob requests to change a job's state from JOB_STATE_RUNNING to JOB_STATE_CANCELLED, JOB_STATE_DONE, or JOB_STATE_DRAINED. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on CreateJob requests.

satisfiesPziboolean

Output only. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.

namestring

Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression [a-z]([-a-z0-9]{0,1022}[a-z0-9])?

idstring

The unique ID of this job. This field is set by the Dataflow service when the job is created, and is immutable for the life of the job.

Response

Successful response