Package co.elastic.clients.elasticsearch.ml

Enum Class JobState

java.lang.Object

java.lang.Enum<JobState>

co.elastic.clients.elasticsearch.ml.JobState

All Implemented Interfaces:

JsonEnum, JsonpSerializable, Serializable, Comparable<JobState>, Constable

@JsonpDeserializable
public enum JobState
extends Enum<JobState>
implements JsonEnum

See Also:

• API specification

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface co.elastic.clients.json.JsonEnum

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Closed	The job finished successfully with its model state persisted.
Closing	The job close action is in progress and has not yet completed.
Failed	The job did not finish successfully due to an error.
Opened	The job is available to receive and process data.
Opening	The job open action is in progress and has not yet completed.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonEnum.Deserializer<JobState>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
String	jsonValue()
static JobState	valueOf(String name)	Returns 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.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.JsonEnum

aliases, serialize

Enum Constant Details

Closing

public static final JobState Closing

The job close action is in progress and has not yet completed. A closing job cannot accept further data.

Closed

public static final JobState Closed

The job finished successfully with its model state persisted. The job must be opened before it can accept further data.

Opened

public static final JobState Opened

The job is available to receive and process data.

Failed

public static final JobState Failed

The job did not finish successfully due to an error. This situation can occur due to invalid input data, a fatal error occurring during the analysis, or an external interaction such as the process being killed by the Linux out of memory (OOM) killer. If the job had irrevocably failed, it must be force closed and then deleted. If the datafeed can be corrected, the job can be closed and then re-opened.

Opening

public static final JobState Opening

The job open action is in progress and has not yet completed.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<JobState> _DESERIALIZER

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

jsonValue

public String jsonValue()

Specified by:

jsonValue in interface JsonEnum