Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.job.config

Class JobTaskState

java.lang.Object

org.elasticsearch.xpack.core.ml.job.config.JobTaskState

All Implemented Interfaces:

NamedWriteable, Writeable, PersistentTaskState, ToXContent, ToXContentObject, MlTaskState

public class JobTaskState
extends Object
implements PersistentTaskState, MlTaskState

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
JobTaskState(StreamInput in)
JobTaskState(JobState state, long allocationId, String reason, Instant lastStateChangeTime)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static JobTaskState	fromXContent(XContentParser parser)
long	getAllocationId()
Instant	getLastStateChangeTime()	The time of the last state change.
String	getReason()
JobState	getState()
String	getWriteableName()
int	hashCode()
boolean	isFailed()
boolean	isStatusStale(PersistentTasksCustomMetadata.PersistentTask<?> task)	The job state stores the allocation ID at the time it was last set.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

JobTaskState

public JobTaskState(JobState state,
 long allocationId,
 @Nullable
 String reason,
 @Nullable
 Instant lastStateChangeTime)

JobTaskState

public JobTaskState(StreamInput in)
             throws IOException

Throws:

IOException

Method Details

fromXContent

public static JobTaskState fromXContent(XContentParser parser)

getState

public JobState getState()

getAllocationId

public long getAllocationId()

getReason

@Nullable
public String getReason()

getLastStateChangeTime

@Nullable
public Instant getLastStateChangeTime()

Description copied from interface: MlTaskState

The time of the last state change.

Specified by:

getLastStateChangeTime in interface MlTaskState

isFailed

public boolean isFailed()

Specified by:

isFailed in interface MlTaskState

Returns:

Is the task in the failed state?

isStatusStale

public boolean isStatusStale(PersistentTasksCustomMetadata.PersistentTask<?> task)

The job state stores the allocation ID at the time it was last set. This method compares the allocation ID in the state with the allocation ID in the task. If the two are different then the task has been relocated to a different node after the last time the state was set. This in turn means that the state is not necessarily correct. For example, a job that has a state of OPENED but is stale must be considered to be OPENING, because it won't yet have a corresponding autodetect process.

Parameters:

task - The job task to check.

Returns:

Has the task been relocated to another node and not had its status set since then?

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object