Package org.elasticsearch.cluster.metadata

Class NodesShutdownMetadata

java.lang.Object

org.elasticsearch.cluster.metadata.NodesShutdownMetadata

All Implemented Interfaces:

ClusterState.FeatureAware, Diffable<Metadata.Custom>, Metadata.Custom, NamedDiffable<Metadata.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable, ToXContent, ToXContentFragment

public class NodesShutdownMetadata
extends Object
implements Metadata.Custom

Contains the data about nodes which are currently configured to shut down, either permanently or temporarily. Stored in the cluster state as custom metadata.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NodesShutdownMetadata.NodeShutdownMetadataDiff	Handles diffing and appling diffs for NodesShutdownMetadata as necessary for the cluster state infrastructure.

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 Version	NODE_SHUTDOWN_VERSION
static final ConstructingObjectParser<NodesShutdownMetadata,Void>	PARSER
static final String	TYPE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
NodesShutdownMetadata(Map<String,SingleNodeShutdownMetadata> nodes)
NodesShutdownMetadata(StreamInput in)

Method Summary

Modifier and Type	Method	Description
EnumSet<Metadata.XContentContext>	context()
Diff<Metadata.Custom>	diff(Metadata.Custom previousState)	Returns serializable object representing differences between this and previousState
boolean	equals(Object o)
static NodesShutdownMetadata	fromXContent(XContentParser parser)
Map<String,SingleNodeShutdownMetadata>	getAllNodeMetadataMap()
Version	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
static Optional<NodesShutdownMetadata>	getShutdowns(ClusterState state)
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
NodesShutdownMetadata	putSingleNodeMetadata(SingleNodeShutdownMetadata nodeShutdownMetadata)	Add or update the shutdown metadata for a single node.
static NamedDiff<Metadata.Custom>	readDiffFrom(StreamInput in)
NodesShutdownMetadata	removeSingleNodeMetadata(String nodeId)	Removes all shutdown metadata for a particular node ID.
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, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.cluster.ClusterState.FeatureAware

getRequiredFeature

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

NODE_SHUTDOWN_VERSION

public static final Version NODE_SHUTDOWN_VERSION

PARSER

public static final ConstructingObjectParser<NodesShutdownMetadata,Void> PARSER

Constructor Details

NodesShutdownMetadata

public NodesShutdownMetadata(Map<String,SingleNodeShutdownMetadata> nodes)

NodesShutdownMetadata

public NodesShutdownMetadata(StreamInput in)
                      throws IOException

Throws:

IOException

Method Details

fromXContent

public static NodesShutdownMetadata fromXContent(XContentParser parser)

readDiffFrom

public static NamedDiff<Metadata.Custom> readDiffFrom(StreamInput in)
                                               throws IOException

Throws:

IOException

getShutdowns

public static Optional<NodesShutdownMetadata> getShutdowns(ClusterState state)

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

getAllNodeMetadataMap

public Map<String,SingleNodeShutdownMetadata> getAllNodeMetadataMap()

Returns:

A map of NodeID to shutdown metadata.

putSingleNodeMetadata

public NodesShutdownMetadata putSingleNodeMetadata(SingleNodeShutdownMetadata nodeShutdownMetadata)

Add or update the shutdown metadata for a single node.

Parameters:

nodeShutdownMetadata - The single node shutdown metadata to add or update.

Returns:

A new NodesShutdownMetadata that reflects the updated value.

removeSingleNodeMetadata

public NodesShutdownMetadata removeSingleNodeMetadata(String nodeId)

Removes all shutdown metadata for a particular node ID.

Parameters:

nodeId - The node ID to remove shutdown metadata for.

Returns:

A new NodesShutdownMetadata that does not contain shutdown metadata for the given node.

diff

public Diff<Metadata.Custom> diff(Metadata.Custom previousState)

Description copied from interface: Diffable

Returns serializable object representing differences between this and previousState

Specified by:

diff in interface Diffable<Metadata.Custom>

context

public EnumSet<Metadata.XContentContext> context()

Specified by:

context in interface Metadata.Custom

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public Version getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException