Dataflow V1beta3 API - Module Google::Cloud::Dataflow::V1beta3::JobState (v0.7.0)

Version 0.7.0

• 0.9.1 (latest)
• 0.9.0
• 0.8.2
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.4

Reference documentation and code samples for the Dataflow V1beta3 API module Google::Cloud::Dataflow::V1beta3::JobState.

Describes the overall state of a google.dataflow.v1beta3.Job.

Constants

JOB_STATE_UNKNOWN

value: 0
The job's run state isn't specified.

JOB_STATE_STOPPED

value: 1
JOB_STATE_STOPPED indicates that the job has not yet started to run.

JOB_STATE_RUNNING

value: 2
JOB_STATE_RUNNING indicates that the job is currently running.

JOB_STATE_DONE

value: 3
JOB_STATE_DONE indicates that the job has successfully completed. This is a terminal job state. This state may be set by the Cloud Dataflow service, as a transition from JOB_STATE_RUNNING. It may also be set via a Cloud Dataflow UpdateJob call, if the job has not yet reached a terminal state.

JOB_STATE_FAILED

value: 4
JOB_STATE_FAILED indicates that the job has failed. This is a terminal job state. This state may only be set by the Cloud Dataflow service, and only as a transition from JOB_STATE_RUNNING.

JOB_STATE_CANCELLED

value: 5
JOB_STATE_CANCELLED indicates that the job has been explicitly cancelled. This is a terminal job state. This state may only be set via a Cloud Dataflow UpdateJob call, and only if the job has not yet reached another terminal state.

JOB_STATE_UPDATED

value: 6
JOB_STATE_UPDATED indicates that the job was successfully updated, meaning that this job was stopped and another job was started, inheriting state from this one. This is a terminal job state. This state may only be set by the Cloud Dataflow service, and only as a transition from JOB_STATE_RUNNING.

JOB_STATE_DRAINING

value: 7
JOB_STATE_DRAINING indicates that the job is in the process of draining. A draining job has stopped pulling from its input sources and is processing any data that remains in-flight. This state may be set via a Cloud Dataflow UpdateJob call, but only as a transition from JOB_STATE_RUNNING. Jobs that are draining may only transition to JOB_STATE_DRAINED, JOB_STATE_CANCELLED, or JOB_STATE_FAILED.

JOB_STATE_DRAINED

value: 8
JOB_STATE_DRAINED indicates that the job has been drained. A drained job terminated by stopping pulling from its input sources and processing any data that remained in-flight when draining was requested. This state is a terminal state, may only be set by the Cloud Dataflow service, and only as a transition from JOB_STATE_DRAINING.

JOB_STATE_PENDING

value: 9
JOB_STATE_PENDING indicates that the job has been created but is not yet running. Jobs that are pending may only transition to JOB_STATE_RUNNING, or JOB_STATE_FAILED.

JOB_STATE_CANCELLING

value: 10
JOB_STATE_CANCELLING indicates that the job has been explicitly cancelled and is in the process of stopping. Jobs that are cancelling may only transition to JOB_STATE_CANCELLED or JOB_STATE_FAILED.

JOB_STATE_QUEUED

value: 11
JOB_STATE_QUEUED indicates that the job has been created but is being delayed until launch. Jobs that are queued may only transition to JOB_STATE_PENDING or JOB_STATE_CANCELLED.

JOB_STATE_RESOURCE_CLEANING_UP

value: 12
JOB_STATE_RESOURCE_CLEANING_UP indicates that the batch job's associated resources are currently being cleaned up after a successful run. Currently, this is an opt-in feature, please reach out to Cloud support team if you are interested.