Package com.google.dataflow.v1beta3

Enum JobState

java.lang.Object
java.lang.Enum<JobState>
com.google.dataflow.v1beta3.JobState
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<JobState>
@Generated public enum JobState extends Enum<JobState> implements com.google.protobuf.ProtocolMessageEnum
 Describes the overall state of a
 [google.dataflow.v1beta3.Job][google.dataflow.v1beta3.Job].
Protobuf enum google.dataflow.v1beta3.JobState

  • Enum Constant Details

    • JOB_STATE_UNKNOWN

      public static final JobState JOB_STATE_UNKNOWN
       The job's run state isn't specified.
      JOB_STATE_UNKNOWN = 0;

    • JOB_STATE_STOPPED

      public static final JobState JOB_STATE_STOPPED
       `JOB_STATE_STOPPED` indicates that the job has not
 yet started to run.
      JOB_STATE_STOPPED = 1;

    • JOB_STATE_RUNNING

      public static final JobState JOB_STATE_RUNNING
       `JOB_STATE_RUNNING` indicates that the job is currently running.
      JOB_STATE_RUNNING = 2;

    • JOB_STATE_DONE

      public static final JobState 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 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_DONE = 3;

    • JOB_STATE_FAILED

      public static final JobState 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 from `JOB_STATE_RUNNING`.
      JOB_STATE_FAILED = 4;

    • JOB_STATE_CANCELLED

      public static final JobState 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 Dataflow `UpdateJob` call, and only if the job has not
 yet reached another terminal state.
      JOB_STATE_CANCELLED = 5;

    • JOB_STATE_UPDATED

      public static final JobState 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 from
 `JOB_STATE_RUNNING`.
      JOB_STATE_UPDATED = 6;

    • JOB_STATE_DRAINING

      public static final JobState 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 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_DRAINING = 7;

    • JOB_STATE_DRAINED

      public static final JobState 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 from `JOB_STATE_DRAINING`.
      JOB_STATE_DRAINED = 8;

    • JOB_STATE_PENDING

      public static final JobState 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 to `JOB_STATE_RUNNING`,
 or `JOB_STATE_FAILED`.
      JOB_STATE_PENDING = 9;

    • JOB_STATE_CANCELLING

      public static final JobState 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 to `JOB_STATE_CANCELLED` or `JOB_STATE_FAILED`.
      JOB_STATE_CANCELLING = 10;

    • JOB_STATE_QUEUED

      public static final JobState 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 to
 `JOB_STATE_PENDING` or `JOB_STATE_CANCELLED`.
      JOB_STATE_QUEUED = 11;

    • JOB_STATE_RESOURCE_CLEANING_UP

      public static final JobState 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.
      JOB_STATE_RESOURCE_CLEANING_UP = 12;

    • JOB_STATE_PAUSING

      public static final JobState JOB_STATE_PAUSING
       `JOB_STATE_PAUSING` is not implemented yet.
      JOB_STATE_PAUSING = 13;

    • JOB_STATE_PAUSED

      public static final JobState JOB_STATE_PAUSED
       `JOB_STATE_PAUSED` is not implemented yet.
      JOB_STATE_PAUSED = 14;

    • UNRECOGNIZED

      public static final JobState UNRECOGNIZED

  • Field Details

    • JOB_STATE_UNKNOWN_VALUE

      public static final int JOB_STATE_UNKNOWN_VALUE
       The job's run state isn't specified.
      JOB_STATE_UNKNOWN = 0;
      See Also:

    • JOB_STATE_STOPPED_VALUE

      public static final int JOB_STATE_STOPPED_VALUE
       `JOB_STATE_STOPPED` indicates that the job has not
 yet started to run.
      JOB_STATE_STOPPED = 1;
      See Also:

    • JOB_STATE_RUNNING_VALUE

      public static final int JOB_STATE_RUNNING_VALUE
       `JOB_STATE_RUNNING` indicates that the job is currently running.
      JOB_STATE_RUNNING = 2;
      See Also:

    • JOB_STATE_DONE_VALUE

      public static final int JOB_STATE_DONE_VALUE
       `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_DONE = 3;
      See Also:

    • JOB_STATE_FAILED_VALUE

      public static final int JOB_STATE_FAILED_VALUE
       `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_FAILED = 4;
      See Also:

    • JOB_STATE_CANCELLED_VALUE

      public static final int JOB_STATE_CANCELLED_VALUE
       `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_CANCELLED = 5;
      See Also:

    • JOB_STATE_UPDATED_VALUE

      public static final int JOB_STATE_UPDATED_VALUE
       `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_UPDATED = 6;
      See Also:

    • JOB_STATE_DRAINING_VALUE

      public static final int JOB_STATE_DRAINING_VALUE
       `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_DRAINING = 7;
      See Also:

    • JOB_STATE_DRAINED_VALUE

      public static final int JOB_STATE_DRAINED_VALUE
       `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_DRAINED = 8;
      See Also:

    • JOB_STATE_PENDING_VALUE

      public static final int JOB_STATE_PENDING_VALUE
       `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_PENDING = 9;
      See Also:

    • JOB_STATE_CANCELLING_VALUE

      public static final int JOB_STATE_CANCELLING_VALUE
       `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_CANCELLING = 10;
      See Also:

    • JOB_STATE_QUEUED_VALUE

      public static final int JOB_STATE_QUEUED_VALUE
       `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_QUEUED = 11;
      See Also:

    • JOB_STATE_RESOURCE_CLEANING_UP_VALUE

      public static final int JOB_STATE_RESOURCE_CLEANING_UP_VALUE
       `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.
      JOB_STATE_RESOURCE_CLEANING_UP = 12;
      See Also:

    • JOB_STATE_PAUSING_VALUE

      public static final int JOB_STATE_PAUSING_VALUE
       `JOB_STATE_PAUSING` is not implemented yet.
      JOB_STATE_PAUSING = 13;
      See Also:

    • JOB_STATE_PAUSED_VALUE

      public static final int JOB_STATE_PAUSED_VALUE
       `JOB_STATE_PAUSED` is not implemented yet.
      JOB_STATE_PAUSED = 14;
      See Also:

  • Method Details

    • values

      public static JobState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static JobState valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static JobState valueOf(int value)
      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static JobState forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<JobState> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static JobState valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null