Package org.apache.beam.sdk

Enum PipelineResult.State

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PipelineResult.State>
    Enclosing interface:
    PipelineResult
    public static enum PipelineResult.State
extends java.lang.Enum<PipelineResult.State>
    Possible job states, for both completed and ongoing jobs.

    When determining if a job is still running, consult the isTerminal() method rather than inspecting the precise state.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CANCELLED
      The job has been explicitly cancelled.
      DONE
      The job has successfully completed.
      FAILED
      The job has failed.
      RUNNING
      The job is currently running.
      STOPPED
      The job has been paused, or has not yet started.
      UNKNOWN
      The job state was not specified or unknown to a runner.
      UNRECOGNIZED
      The job state reported by a runner cannot be interpreted by the SDK.
      UPDATED
      The job has been updated.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean hasReplacementJob()  
      boolean isTerminal()  
      static PipelineResult.State valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PipelineResult.State[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

        public static PipelineResult.State[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (PipelineResult.State c : PipelineResult.State.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static PipelineResult.State valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • isTerminal

        public final boolean isTerminal()
        Returns:
        true if the job state can no longer complete work.

      • hasReplacementJob

        public final boolean hasReplacementJob()
        Returns:
        true if this job state indicates that a replacement job exists.