Package org.elasticsearch.cluster.metadata

Class SingleNodeShutdownMetadata

java.lang.Object

org.elasticsearch.cluster.AbstractDiffable<SingleNodeShutdownMetadata>

org.elasticsearch.cluster.metadata.SingleNodeShutdownMetadata

All Implemented Interfaces:

Diffable<SingleNodeShutdownMetadata>, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject

public class SingleNodeShutdownMetadata
extends AbstractDiffable<SingleNodeShutdownMetadata>
implements org.elasticsearch.common.xcontent.ToXContentObject, Diffable<SingleNodeShutdownMetadata>

Contains data about a single node's shutdown readiness.

Nested Class Summary

Nested Classes

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

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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 org.elasticsearch.common.xcontent.ParseField	NODE_ID_FIELD
static org.elasticsearch.common.xcontent.ConstructingObjectParser<SingleNodeShutdownMetadata,Void>	PARSER
static org.elasticsearch.common.xcontent.ParseField	REASON_FIELD
static org.elasticsearch.common.xcontent.ParseField	STARTED_AT_MILLIS_FIELD
static String	STARTED_AT_READABLE_FIELD
static org.elasticsearch.common.xcontent.ParseField	TYPE_FIELD

Fields inherited from interface org.elasticsearch.common.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)
String	getNodeId()
String	getReason()
long	getStartedAtMillis()
SingleNodeShutdownMetadata.Type	getType()
int	hashCode()
static SingleNodeShutdownMetadata	parse(org.elasticsearch.common.xcontent.XContentParser parser)
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.cluster.AbstractDiffable

diff, readDiffFrom

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Details

NODE_ID_FIELD

public static final org.elasticsearch.common.xcontent.ParseField NODE_ID_FIELD

TYPE_FIELD

public static final org.elasticsearch.common.xcontent.ParseField TYPE_FIELD

REASON_FIELD

public static final org.elasticsearch.common.xcontent.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 org.elasticsearch.common.xcontent.ParseField STARTED_AT_MILLIS_FIELD

PARSER

public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<SingleNodeShutdownMetadata,Void> PARSER

Constructor Details

SingleNodeShutdownMetadata

public SingleNodeShutdownMetadata(StreamInput in)
                           throws IOException

Throws:

IOException

Method Details

parse

public static SingleNodeShutdownMetadata parse(org.elasticsearch.common.xcontent.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.

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 org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws IOException

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static SingleNodeShutdownMetadata.Builder builder()

builder

public static SingleNodeShutdownMetadata.Builder builder(SingleNodeShutdownMetadata original)