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.
[[["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-09-09 UTC."],[],[],null,["# Dataflow V1beta3 API - Module Google::Cloud::Dataflow::V1beta3::JobState (v0.13.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.13.1 (latest)](/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-JobState)\n- [0.13.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.13.0/Google-Cloud-Dataflow-V1beta3-JobState)\n- [0.12.1](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.12.1/Google-Cloud-Dataflow-V1beta3-JobState)\n- [0.11.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.11.0/Google-Cloud-Dataflow-V1beta3-JobState)\n- [0.10.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.10.0/Google-Cloud-Dataflow-V1beta3-JobState)\n- [0.9.1](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.9.1/Google-Cloud-Dataflow-V1beta3-JobState)\n- [0.8.2](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.8.2/Google-Cloud-Dataflow-V1beta3-JobState)\n- [0.7.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.7.0/Google-Cloud-Dataflow-V1beta3-JobState)\n- [0.6.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.6.0/Google-Cloud-Dataflow-V1beta3-JobState)\n- [0.5.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.5.0/Google-Cloud-Dataflow-V1beta3-JobState)\n- [0.4.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.4.0/Google-Cloud-Dataflow-V1beta3-JobState)\n- [0.3.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.3.0/Google-Cloud-Dataflow-V1beta3-JobState)\n- [0.2.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.2.0/Google-Cloud-Dataflow-V1beta3-JobState)\n- [0.1.4](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.1.4/Google-Cloud-Dataflow-V1beta3-JobState) \nReference documentation and code samples for the Dataflow V1beta3 API module Google::Cloud::Dataflow::V1beta3::JobState.\n\nDescribes the overall state of a\n[google.dataflow.v1beta3.Job](/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-Job \"Google::Cloud::Dataflow::V1beta3::Job (class)\").\n\nConstants\n---------\n\n### JOB_STATE_UNKNOWN\n\n**value:** 0 \nThe job's run state isn't specified.\n\n### JOB_STATE_STOPPED\n\n**value:** 1 \n`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.\n\n### JOB_STATE_RUNNING\n\n**value:** 2 \n`JOB_STATE_RUNNING` indicates that the job is currently running.\n\n### JOB_STATE_DONE\n\n**value:** 3 \n`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.\n\n### JOB_STATE_FAILED\n\n**value:** 4 \n`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.\n\n### JOB_STATE_CANCELLED\n\n**value:** 5 \n`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.\n\n### JOB_STATE_UPDATED\n\n**value:** 6 \n`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.\n\n### JOB_STATE_DRAINING\n\n**value:** 7 \n`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.\n\n### JOB_STATE_DRAINED\n\n**value:** 8 \n`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.\n\n### JOB_STATE_PENDING\n\n**value:** 9 \n`JOB_STATE_PENDING` indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.\n\n### JOB_STATE_CANCELLING\n\n**value:** 10 \n`JOB_STATE_CANCELLING` indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to `JOB_STATE_CANCELLED` or `JOB_STATE_FAILED`.\n\n### JOB_STATE_QUEUED\n\n**value:** 11 \n`JOB_STATE_QUEUED` indicates that the job has been created but is being\ndelayed until launch. Jobs that are queued may only transition to\n`JOB_STATE_PENDING` or `JOB_STATE_CANCELLED`.\n\n### JOB_STATE_RESOURCE_CLEANING_UP\n\n**value:** 12 \n`JOB_STATE_RESOURCE_CLEANING_UP` indicates that the batch job's associated\nresources are currently being cleaned up after a successful run.\nCurrently, this is an opt-in feature, please reach out to Cloud support\nteam if you are interested."]]
