Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Class ShutdownPersistentTasksStatus

java.lang.Object

org.elasticsearch.cluster.metadata.ShutdownPersistentTasksStatus

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class ShutdownPersistentTasksStatus
extends Object
implements Writeable, ToXContentObject

Tracks the status of persistent tasks on a node that is shutting down.

Reports the total number of persistent tasks still assigned to the shutdown node (persistentTasksRemaining), the subset of those that will be proactively reassigned by the persistent task framework (autoReassignableTasksRemaining), and an overall status that is COMPLETE when no auto reassigned tasks remain or IN_PROGRESS otherwise. If the node is not present and has not been seen in the cluster, the status will be NOT_STARTED.

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 TransportVersion	SHUTDOWN_PERSISTENT_TASKS_STATUS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ShutdownPersistentTasksStatus(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static ShutdownPersistentTasksStatus	fromRemainingTasks(int persistentTasksRemaining, int autoReassignableTasksRemaining)
int	getAutoReassignableTasksRemaining()
int	getPersistentTasksRemaining()
SingleNodeShutdownMetadata.Status	getStatus()
int	hashCode()
static ShutdownPersistentTasksStatus	notStarted()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

SHUTDOWN_PERSISTENT_TASKS_STATUS

public static final TransportVersion SHUTDOWN_PERSISTENT_TASKS_STATUS

Constructor Details

ShutdownPersistentTasksStatus

public ShutdownPersistentTasksStatus(StreamInput in)
                              throws IOException

Throws:

IOException

Method Details

notStarted

public static ShutdownPersistentTasksStatus notStarted()

fromRemainingTasks

public static ShutdownPersistentTasksStatus fromRemainingTasks(int persistentTasksRemaining,
 int autoReassignableTasksRemaining)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

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

getStatus

public SingleNodeShutdownMetadata.Status getStatus()

getPersistentTasksRemaining

public int getPersistentTasksRemaining()

getAutoReassignableTasksRemaining

public int getAutoReassignableTasksRemaining()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object