org.elasticsearch.cluster.routing.allocation

Class RelocationDecision

java.lang.Object

org.elasticsearch.cluster.routing.allocation.RelocationDecision

Direct Known Subclasses:

MoveDecision, RebalanceDecision

public abstract class RelocationDecision
extends java.lang.Object

Represents a decision to relocate a started shard from its current node.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RelocationDecision(Decision.Type finalDecision, java.lang.String finalExplanation, java.lang.String assignedNodeId)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAssignedNodeId() Get the node id that the allocator will assign the shard to, unless getFinalDecisionType() returns a value other than Decision.Type#YES, in which case this returns null.
Decision.Type	getFinalDecisionType() Returns the final decision made by the allocator on whether to assign the shard, and null if no decision was taken.
java.lang.String	getFinalExplanation() Returns the free-text explanation for the reason behind the decision taken in getFinalDecisionType().
boolean	isDecisionTaken() Returns true if a decision was taken by the allocator, false otherwise.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RelocationDecision

protected RelocationDecision(Decision.Type finalDecision,
                             java.lang.String finalExplanation,
                             java.lang.String assignedNodeId)

Method Detail

isDecisionTaken

public boolean isDecisionTaken()

Returns true if a decision was taken by the allocator, false otherwise. If no decision was taken, then the rest of the fields in this object are meaningless and return null.

getFinalDecisionType

public Decision.Type getFinalDecisionType()

Returns the final decision made by the allocator on whether to assign the shard, and null if no decision was taken.

getFinalExplanation

@Nullable
public java.lang.String getFinalExplanation()

Returns the free-text explanation for the reason behind the decision taken in getFinalDecisionType().

getAssignedNodeId

@Nullable
public java.lang.String getAssignedNodeId()

Get the node id that the allocator will assign the shard to, unless getFinalDecisionType() returns a value other than Decision.Type#YES, in which case this returns null.