Module org.elasticsearch.server
Class NodesShutdownMetadata
java.lang.Object
org.elasticsearch.cluster.metadata.NodesShutdownMetadata
- All Implemented Interfaces:
Diffable<Metadata.Custom>
,Metadata.Custom
,NamedDiffable<Metadata.Custom>
,NamedWriteable
,VersionedNamedWriteable
,Writeable
,ChunkedToXContent
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 ClassesModifier and TypeClassDescriptionstatic class
Handles diffing and appling diffs forNodesShutdownMetadata
as necessary for the cluster state infrastructure.Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final NodesShutdownMetadata
static final TransportVersion
static final ConstructingObjectParser<NodesShutdownMetadata,
Void> static final String
-
Constructor Summary
ConstructorsConstructorDescription -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns true if the given node is marked as shutting down with any shutdown type.boolean
contains
(String nodeId, SingleNodeShutdownMetadata.Type type) context()
diff
(Metadata.Custom previousState) Returns serializable object representing differences between this and previousStateboolean
static NodesShutdownMetadata
fromXContent
(XContentParser parser) get
(String nodeId, SingleNodeShutdownMetadata.Type type) getAll()
The minimal version of the recipient this object can be sent toReturns the name of the writeable objectint
hashCode()
putSingleNodeMetadata
(SingleNodeShutdownMetadata nodeShutdownMetadata) Add or update the shutdown metadata for a single node.static NamedDiff<Metadata.Custom>
removeSingleNodeMetadata
(String nodeId) Removes all shutdown metadata for a particular node ID.Iterator<? extends ToXContent>
toXContentChunked
(ToXContent.Params ignored) Create an iterator ofToXContent
chunks for a REST response.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.common.xcontent.ChunkedToXContent
isFragment, toXContentChunkedV7
Methods inherited from interface org.elasticsearch.cluster.metadata.Metadata.Custom
isRestorable
-
Field Details
-
TYPE
- See Also:
-
NODE_SHUTDOWN_VERSION
-
EMPTY
-
PARSER
-
-
Constructor Details
-
NodesShutdownMetadata
-
NodesShutdownMetadata
- Throws:
IOException
-
-
Method Details
-
fromXContent
-
readDiffFrom
- Throws:
IOException
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
getAll
- Returns:
- A map of NodeID to shutdown metadata.
-
getAllNodeIds
- Returns:
- a set of all node ids that might be restarting or shutting down
-
get
- Returns:
- a shutdown entry for the node if exists with any shutdown type
-
contains
Returns true if the given node is marked as shutting down with any shutdown type. -
get
@Nullable public SingleNodeShutdownMetadata get(String nodeId, SingleNodeShutdownMetadata.Type type) - Returns:
- a shutdown entry for the node if exists and matches the supplied type
-
contains
-
putSingleNodeMetadata
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
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
-
hashCode
public int hashCode() -
toXContentChunked
Description copied from interface:ChunkedToXContent
Create an iterator ofToXContent
chunks for a REST response. Each chunk is serialized with the sameXContentBuilder
andToXContent.Params
, which is also the same as theToXContent.Params
passed as theparams
argument. For best results, all chunks should beO(1)
size. The last chunk in the iterator must always yield at least one byte of output. See alsoChunkedToXContentHelper
for some handy utilities.Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.
- Specified by:
toXContentChunked
in interfaceChunkedToXContent
- Returns:
- iterator over chunks of
ToXContent
-