Module org.elasticsearch.xcore
Enum Class JobState
- All Implemented Interfaces:
Serializable,Comparable<JobState>,Constable,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.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic JobStatestatic JobStatefromString(String name) booleanbooleanbooleantoString()value()static JobStateReturns the enum constant of this class with the specified name.static JobState[]values()Returns an array containing the constants of this enum class, in the order they are declared.voidwriteTo(StreamOutput out)
-
Enum Constant Details
-
CLOSING
-
CLOSED
-
OPENED
-
FAILED
-
OPENING
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
fromString
-
fromStream
- Throws:
IOException
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
value
-
isAnyOf
- Returns:
trueif state matches any of the givencandidates
-
isNoneOf
- Returns:
trueif state matches none of the givencandidates
-
toString
-
consumesMemory
public boolean consumesMemory()- Specified by:
consumesMemoryin interfaceMemoryTrackedTaskState
-
isAllocating
public boolean isAllocating()- Specified by:
isAllocatingin interfaceMemoryTrackedTaskState
-