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
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
public class NodesShutdownMetadata extends java.lang.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 forNodesShutdownMetadata
as necessary for the cluster state infrastructure.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 Version
NODE_SHUTDOWN_VERSION
static org.elasticsearch.common.xcontent.ConstructingObjectParser<NodesShutdownMetadata,java.lang.Void>
PARSER
static java.lang.String
TYPE
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
Constructors Constructor Description NodesShutdownMetadata(java.util.Map<java.lang.String,SingleNodeShutdownMetadata> nodes)
NodesShutdownMetadata(StreamInput in)
-
Method Summary
Modifier and Type Method Description java.util.EnumSet<Metadata.XContentContext>
context()
Diff<Metadata.Custom>
diff(Metadata.Custom previousState)
Returns serializable object representing differences between this and previousStateboolean
equals(java.lang.Object o)
static NodesShutdownMetadata
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
java.util.Map<java.lang.String,SingleNodeShutdownMetadata>
getAllNodeMetdataMap()
Version
getMinimalSupportedVersion()
The minimal version of the recipient this object can be sent tojava.lang.String
getWriteableName()
Returns the name of the writeable objectint
hashCode()
NodesShutdownMetadata
putSingleNodeMetadata(SingleNodeShutdownMetadata nodeShutdownMetadata)
Add or update the shutdown metadata for a single node.static NamedDiff<Metadata.Custom>
readDiffFrom(StreamInput in)
NodesShutdownMetadata
removeSingleNodeMetadata(java.lang.String nodeId)
Removes all shutdown metadata for a particular node ID.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 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.common.xcontent.ToXContentFragment
isFragment
-
Field Details
-
TYPE
public static final java.lang.String TYPE- See Also:
- Constant Field Values
-
NODE_SHUTDOWN_VERSION
-
PARSER
public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<NodesShutdownMetadata,java.lang.Void> PARSER
-
-
Constructor Details
-
NodesShutdownMetadata
-
NodesShutdownMetadata
- Throws:
java.io.IOException
-
-
Method Details
-
fromXContent
public static NodesShutdownMetadata fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) -
readDiffFrom
- Throws:
java.io.IOException
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
getAllNodeMetdataMap
- 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
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
Description copied from interface:Diffable
Returns serializable object representing differences between this and previousState- Specified by:
diff
in interfaceDiffable<Metadata.Custom>
-
context
- Specified by:
context
in interfaceMetadata.Custom
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:VersionedNamedWriteable
Returns the name of the writeable object- Specified by:
getWriteableName
in interfaceNamedWriteable
- Specified by:
getWriteableName
in interfaceVersionedNamedWriteable
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteable
The minimal version of the recipient this object can be sent to- Specified by:
getMinimalSupportedVersion
in interfaceVersionedNamedWriteable
-
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-