Class ClusterAllocationExplanation
java.lang.Object
org.elasticsearch.action.admin.cluster.allocation.ClusterAllocationExplanation
- All Implemented Interfaces:
Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public final class ClusterAllocationExplanation extends java.lang.Object implements org.elasticsearch.common.xcontent.ToXContentObject, Writeable
A
ClusterAllocationExplanation
is an explanation of why a shard is unassigned,
or if it is not unassigned, then which nodes it could possibly be relocated to.
It is an immutable class.-
Nested Class Summary
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 inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
Constructors Constructor Description ClusterAllocationExplanation(ShardRouting shardRouting, DiscoveryNode currentNode, DiscoveryNode relocationTargetNode, ClusterInfo clusterInfo, ShardAllocationDecision shardAllocationDecision)
ClusterAllocationExplanation(StreamInput in)
-
Method Summary
Modifier and Type Method Description ClusterInfo
getClusterInfo()
Returns the cluster disk info for the cluster, ornull
if none available.DiscoveryNode
getCurrentNode()
Returns the currently assigned node, ornull
if the shard is unassigned.DiscoveryNode
getRelocationTargetNode()
Returns the relocating target node, ornull
if the shard is not in theShardRoutingState.RELOCATING
state.ShardId
getShard()
Returns the shard that the explanation is about.ShardAllocationDecision
getShardAllocationDecision()
Returns the shard allocation decision for attempting to assign or move the shard.ShardRoutingState
getShardState()
Returns the currentShardRoutingState
of the shard.UnassignedInfo
getUnassignedInfo()
Returns the unassigned info for the shard, ornull
if the shard is active.boolean
isPrimary()
Returnstrue
if the explained shard is primary,false
otherwise.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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
ClusterAllocationExplanation
public ClusterAllocationExplanation(ShardRouting shardRouting, @Nullable DiscoveryNode currentNode, @Nullable DiscoveryNode relocationTargetNode, @Nullable ClusterInfo clusterInfo, ShardAllocationDecision shardAllocationDecision) -
ClusterAllocationExplanation
- Throws:
java.io.IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
getShard
Returns the shard that the explanation is about. -
isPrimary
public boolean isPrimary()Returnstrue
if the explained shard is primary,false
otherwise. -
getShardState
Returns the currentShardRoutingState
of the shard. -
getCurrentNode
Returns the currently assigned node, ornull
if the shard is unassigned. -
getRelocationTargetNode
Returns the relocating target node, ornull
if the shard is not in theShardRoutingState.RELOCATING
state. -
getUnassignedInfo
Returns the unassigned info for the shard, ornull
if the shard is active. -
getClusterInfo
Returns the cluster disk info for the cluster, ornull
if none available. -
getShardAllocationDecision
Returns the shard allocation decision for attempting to assign or move the shard. -
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
-