Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Class SingleNodeShutdownMetadata

java.lang.Object

org.elasticsearch.cluster.metadata.SingleNodeShutdownMetadata

All Implemented Interfaces:

Diffable<SingleNodeShutdownMetadata>, SimpleDiffable<SingleNodeShutdownMetadata>, Writeable, ToXContent, ToXContentObject

public class SingleNodeShutdownMetadata
extends Object
implements SimpleDiffable<SingleNodeShutdownMetadata>, ToXContentObject

Contains data about a single node's shutdown readiness.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SingleNodeShutdownMetadata.Builder
static enum	SingleNodeShutdownMetadata.Status	Describes the status of a component of shutdown.
static enum	SingleNodeShutdownMetadata.Type	Describes the type of node shutdown - permanent (REMOVE) or temporary (RESTART).

Nested classes/interfaces inherited from interface org.elasticsearch.cluster.SimpleDiffable

SimpleDiffable.CompleteDiff<T extends Diffable<T>>

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 ParseField	ALLOCATION_DELAY_FIELD
static final TimeValue	DEFAULT_RESTART_SHARD_ALLOCATION_DELAY
static final ParseField	NODE_ID_FIELD
static final ParseField	NODE_SEEN_FIELD
static final ConstructingObjectParser<SingleNodeShutdownMetadata,Void>	PARSER
static final ParseField	REASON_FIELD
static final Version	REPLACE_SHUTDOWN_TYPE_ADDED_VERSION
static final ParseField	STARTED_AT_MILLIS_FIELD
static final String	STARTED_AT_READABLE_FIELD
static final ParseField	TARGET_NODE_NAME_FIELD
static final ParseField	TYPE_FIELD

Fields inherited from interface org.elasticsearch.cluster.SimpleDiffable

EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SingleNodeShutdownMetadata(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static SingleNodeShutdownMetadata.Builder	builder()
static SingleNodeShutdownMetadata.Builder	builder(SingleNodeShutdownMetadata original)
boolean	equals(Object o)
TimeValue	getAllocationDelay()
String	getNodeId()
boolean	getNodeSeen()
String	getReason()
long	getStartedAtMillis()
String	getTargetNodeName()
SingleNodeShutdownMetadata.Type	getType()
int	hashCode()
static SingleNodeShutdownMetadata	parse(XContentParser parser)
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.cluster.SimpleDiffable

diff

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

REPLACE_SHUTDOWN_TYPE_ADDED_VERSION

public static final Version REPLACE_SHUTDOWN_TYPE_ADDED_VERSION

NODE_ID_FIELD

public static final ParseField NODE_ID_FIELD

TYPE_FIELD

public static final ParseField TYPE_FIELD

REASON_FIELD

public static final ParseField REASON_FIELD

STARTED_AT_READABLE_FIELD

public static final String STARTED_AT_READABLE_FIELD

See Also:

• Constant Field Values

STARTED_AT_MILLIS_FIELD

public static final ParseField STARTED_AT_MILLIS_FIELD

ALLOCATION_DELAY_FIELD

public static final ParseField ALLOCATION_DELAY_FIELD

NODE_SEEN_FIELD

public static final ParseField NODE_SEEN_FIELD

TARGET_NODE_NAME_FIELD

public static final ParseField TARGET_NODE_NAME_FIELD

PARSER

public static final ConstructingObjectParser<SingleNodeShutdownMetadata,Void> PARSER

DEFAULT_RESTART_SHARD_ALLOCATION_DELAY

public static final TimeValue DEFAULT_RESTART_SHARD_ALLOCATION_DELAY

Constructor Details

SingleNodeShutdownMetadata

public SingleNodeShutdownMetadata(StreamInput in)
                           throws IOException

Throws:

IOException

Method Details

parse

public static SingleNodeShutdownMetadata parse(XContentParser parser)

getNodeId

public String getNodeId()

Returns:

The ID of the node this SingleNodeShutdownMetadata concerns.

getType

public SingleNodeShutdownMetadata.Type getType()

Returns:

The type of shutdown this is (shutdown vs. permanent).

getReason

public String getReason()

Returns:

The user-supplied reason this node is shutting down.

getStartedAtMillis

public long getStartedAtMillis()

Returns:

The timestamp that this shutdown procedure was started.

getNodeSeen

public boolean getNodeSeen()

Returns:

A boolean indicated whether this node has been seen in the cluster since the shutdown was registered.

getTargetNodeName

public String getTargetNodeName()

Returns:

The name of the node to be used as a replacement for this node, or null.

getAllocationDelay

@Nullable
public TimeValue getAllocationDelay()

Returns:

The amount of time shard reallocation should be delayed for shards on this node, so that they will not be automatically reassigned while the node is restarting. Will be null for non-restart shutdowns.

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static SingleNodeShutdownMetadata.Builder builder()

builder

public static SingleNodeShutdownMetadata.Builder builder(SingleNodeShutdownMetadata original)