0.11.3 (latest) 0.10.0 0.9.3 0.8.2 0.7.1 0.6.6 0.5.1 0.4.1 0.3.10

> [!WARNING]
> **Beta**
>
>
> This library is covered by the [Pre-GA Offerings Terms](https://docs.cloud.google.com/terms/service-terms#1)
> of the Terms of Service. Pre-GA libraries might have limited support,
> and changes to pre-GA libraries might not be compatible with other pre-GA versions.
> For more information, see the
> [launch stage descriptions](https://docs.cloud.google.com/products#product-launch-stages).

Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class JobState.

Describes the overall state of a
[google.dataflow.v1beta3.Job](https://docs.cloud.google.com/php/docs/reference/cloud-dataflow/latest/V1beta3.Job).

Protobuf type `google.dataflow.v1beta3.JobState`

## Namespace

Google \\ Cloud \\ Dataflow \\ V1beta3

## Methods

### static::name

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `mixed` |

### static::value

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `mixed` |

## Constants

### JOB_STATE_UNKNOWN

    Value: 0

The job's run state isn't specified.

Generated from protobuf enum `JOB_STATE_UNKNOWN = 0;`

### JOB_STATE_STOPPED

    Value: 1

`JOB_STATE_STOPPED` indicates that the job has not
yet started to run.

Generated from protobuf enum `JOB_STATE_STOPPED = 1;`

### JOB_STATE_RUNNING

    Value: 2

`JOB_STATE_RUNNING` indicates that the job is currently running.

Generated from protobuf enum `JOB_STATE_RUNNING = 2;`

### 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.

Generated from protobuf enum `JOB_STATE_DONE = 3;`

### 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`.

Generated from protobuf enum `JOB_STATE_FAILED = 4;`

### 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.

Generated from protobuf enum `JOB_STATE_CANCELLED = 5;`

### 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`.

Generated from protobuf enum `JOB_STATE_UPDATED = 6;`

### 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`.

Generated from protobuf enum `JOB_STATE_DRAINING = 7;`

### 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`.

Generated from protobuf enum `JOB_STATE_DRAINED = 8;`

### 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`.

Generated from protobuf enum `JOB_STATE_PENDING = 9;`

### 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`.

Generated from protobuf enum `JOB_STATE_CANCELLING = 10;`

### 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`.

Generated from protobuf enum `JOB_STATE_QUEUED = 11;`

### 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.

Generated from protobuf enum `JOB_STATE_RESOURCE_CLEANING_UP = 12;`

### JOB_STATE_PAUSING

    Value: 13

`JOB_STATE_PAUSING` is not implemented yet.

Generated from protobuf enum `JOB_STATE_PAUSING = 13;`

### JOB_STATE_PAUSED

    Value: 14

`JOB_STATE_PAUSED` is not implemented yet.

Generated from protobuf enum `JOB_STATE_PAUSED = 14;`