Module org.elasticsearch.server
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
Modifier and TypeClassDescriptionstatic class
static enum
Describes the status of a component of shutdown.static enum
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
Modifier and TypeFieldDescriptionstatic final ParseField
static final TimeValue
static final ParseField
static final ParseField
static final ConstructingObjectParser<SingleNodeShutdownMetadata,
Void> static final ParseField
static final Version
static final ParseField
static final String
static final ParseField
static final ParseField
Fields inherited from interface org.elasticsearch.cluster.SimpleDiffable
EMPTY
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder
(SingleNodeShutdownMetadata original) boolean
boolean
long
getType()
int
hashCode()
static SingleNodeShutdownMetadata
parse
(XContentParser parser) toString()
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
-
NODE_ID_FIELD
-
TYPE_FIELD
-
REASON_FIELD
-
STARTED_AT_READABLE_FIELD
- See Also:
-
STARTED_AT_MILLIS_FIELD
-
ALLOCATION_DELAY_FIELD
-
NODE_SEEN_FIELD
-
TARGET_NODE_NAME_FIELD
-
PARSER
-
DEFAULT_RESTART_SHARD_ALLOCATION_DELAY
-
-
Constructor Details
-
SingleNodeShutdownMetadata
- Throws:
IOException
-
-
Method Details
-
parse
-
getNodeId
- Returns:
- The ID of the node this
SingleNodeShutdownMetadata
concerns.
-
getType
- Returns:
- The type of shutdown this is (shutdown vs. permanent).
-
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
- Returns:
- The name of the node to be used as a replacement for this node, or null.
-
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
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceToXContent
- Throws:
IOException
-
equals
-
hashCode
public int hashCode() -
toString
-
builder
-
builder
-