Module: Google::Cloud::Dataflow::V1beta3::JobState
- Defined in:
- proto_docs/google/dataflow/v1beta3/jobs.rb
Overview
Describes the overall state of a google.dataflow.v1beta3.Job.
Constant Summary collapse
- JOB_STATE_UNKNOWN =
The job's run state isn't specified.
0
- JOB_STATE_STOPPED =
JOB_STATE_STOPPED
indicates that the job has not yet started to run. 1
- JOB_STATE_RUNNING =
JOB_STATE_RUNNING
indicates that the job is currently running. 2
- JOB_STATE_DONE =
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 fromJOB_STATE_RUNNING
. It may also be set via a Cloud DataflowUpdateJob
call, if the job has not yet reached a terminal state. 3
- JOB_STATE_FAILED =
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 fromJOB_STATE_RUNNING
. 4
- JOB_STATE_CANCELLED =
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 DataflowUpdateJob
call, and only if the job has not yet reached another terminal state. 5
- JOB_STATE_UPDATED =
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 fromJOB_STATE_RUNNING
. 6
- JOB_STATE_DRAINING =
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 DataflowUpdateJob
call, but only as a transition fromJOB_STATE_RUNNING
. Jobs that are draining may only transition toJOB_STATE_DRAINED
,JOB_STATE_CANCELLED
, orJOB_STATE_FAILED
. 7
- JOB_STATE_DRAINED =
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 fromJOB_STATE_DRAINING
. 8
- JOB_STATE_PENDING =
JOB_STATE_PENDING
indicates that the job has been created but is not yet running. Jobs that are pending may only transition toJOB_STATE_RUNNING
, orJOB_STATE_FAILED
. 9
- JOB_STATE_CANCELLING =
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 toJOB_STATE_CANCELLED
orJOB_STATE_FAILED
. 10
- JOB_STATE_QUEUED =
JOB_STATE_QUEUED
indicates that the job has been created but is being delayed until launch. Jobs that are queued may only transition toJOB_STATE_PENDING
orJOB_STATE_CANCELLED
. 11
- JOB_STATE_RESOURCE_CLEANING_UP =
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. 12