java.lang.Object
java.lang.Enum<JobState>
org.elasticsearch.xpack.core.ml.job.config.JobState
All Implemented Interfaces:
Serializable, Comparable<JobState>, Constable, Writeable, MemoryTrackedTaskState

public enum JobState extends Enum<JobState> implements Writeable, MemoryTrackedTaskState
Jobs whether running or complete are in one of these states. When a job is created it is initialised in to the state closed i.e. it is not running.
  • Enum Constant Details

    • CLOSING

      public static final JobState CLOSING
    • CLOSED

      public static final JobState CLOSED
    • OPENED

      public static final JobState OPENED
    • FAILED

      public static final JobState FAILED
    • OPENING

      public static final JobState OPENING
  • Method Details

    • values

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

      public static JobState valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null
    • fromString

      public static JobState fromString(String name)
    • fromStream

      public static JobState fromStream(StreamInput in) throws IOException
      Throws:
      IOException
    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException
    • value

      public String value()
    • isAnyOf

      public boolean isAnyOf(JobState... candidates)
      Returns:
      true if state matches any of the given candidates
    • isNoneOf

      public boolean isNoneOf(JobState... candidates)
      Returns:
      true if state matches none of the given candidates
    • toString

      public String toString()
      Overrides:
      toString in class Enum<JobState>
    • consumesMemory

      public boolean consumesMemory()
      Specified by:
      consumesMemory in interface MemoryTrackedTaskState
    • isAllocating

      public boolean isAllocating()
      Specified by:
      isAllocating in interface MemoryTrackedTaskState