Package org.elasticsearch.cluster.routing.allocation

Class AbstractAllocationDecision

java.lang.Object

org.elasticsearch.cluster.routing.allocation.AbstractAllocationDecision

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

Direct Known Subclasses:

AllocateUnassignedDecision, MoveDecision

public abstract class AbstractAllocationDecision
extends Object
implements ToXContentFragment, Writeable

An abstract class for representing various types of allocation decisions.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.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

Fields

Modifier and Type	Field	Description
protected List<NodeAllocationResult>	nodeDecisions
protected DiscoveryNode	targetNode

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAllocationDecision(DiscoveryNode targetNode, List<NodeAllocationResult> nodeDecisions)
protected	AbstractAllocationDecision(StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected boolean	atLeastOneNodeWithYesDecision()	Returns true if there is at least one node that returned a Decision.Type.YES decision for allocating this shard.
protected void	checkDecisionState()
static XContentBuilder	discoveryNodeToXContent(DiscoveryNode node, boolean outerObjectWritten, XContentBuilder builder)	Generates X-Content for a DiscoveryNode that leaves off some of the non-critical fields.
boolean	equals(Object other)
abstract String	getExplanation()	Gets the explanation for the decision.
List<NodeAllocationResult>	getNodeDecisions()	Gets the sorted list of individual node-level decisions that went into making the ultimate decision whether to allocate or move the shard.
DiscoveryNode	getTargetNode()	Get the node that the allocator will assign the shard to, returning null if there is no node to which the shard will be assigned or moved.
int	hashCode()
abstract boolean	isDecisionTaken()	Returns true if a decision was taken by the allocator, false otherwise.
XContentBuilder	nodeDecisionsToXContent(List<NodeAllocationResult> nodeDecisions, XContentBuilder builder, ToXContent.Params params)	Generates X-Content for the node-level decisions, creating the outer "node_decisions" object in which they are serialized.
List<NodeAllocationResult>	sortNodeDecisions(List<NodeAllocationResult> nodeDecisions)	Sorts a list of node level decisions by the decision type, then by weight ranking, and finally by node id.
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.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Detail

targetNode

@Nullable
protected final DiscoveryNode targetNode

nodeDecisions

@Nullable
protected final List<NodeAllocationResult> nodeDecisions

Constructor Detail

AbstractAllocationDecision

protected AbstractAllocationDecision(@Nullable
                                     DiscoveryNode targetNode,
                                     @Nullable
                                     List<NodeAllocationResult> nodeDecisions)

AbstractAllocationDecision

protected AbstractAllocationDecision(StreamInput in)
                              throws IOException

Throws:

IOException

Method Detail

isDecisionTaken

public abstract 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 cannot be accessed and will throw an IllegalStateException.

getTargetNode

@Nullable
public DiscoveryNode getTargetNode()

Get the node that the allocator will assign the shard to, returning null if there is no node to which the shard will be assigned or moved. If isDecisionTaken() returns false, then invoking this method will throw an IllegalStateException.

getNodeDecisions

@Nullable
public List<NodeAllocationResult> getNodeDecisions()

Gets the sorted list of individual node-level decisions that went into making the ultimate decision whether to allocate or move the shard. If isDecisionTaken() returns false, then invoking this method will throw an IllegalStateException.

getExplanation

public abstract String getExplanation()

Gets the explanation for the decision. If isDecisionTaken() returns false, then invoking this method will throw an IllegalStateException.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

checkDecisionState

protected void checkDecisionState()

discoveryNodeToXContent

public static XContentBuilder discoveryNodeToXContent(DiscoveryNode node,
                                                      boolean outerObjectWritten,
                                                      XContentBuilder builder)
                                               throws IOException

Generates X-Content for a DiscoveryNode that leaves off some of the non-critical fields.

Throws:

IOException

sortNodeDecisions

public List<NodeAllocationResult> sortNodeDecisions(List<NodeAllocationResult> nodeDecisions)

Sorts a list of node level decisions by the decision type, then by weight ranking, and finally by node id.

nodeDecisionsToXContent

public XContentBuilder nodeDecisionsToXContent(List<NodeAllocationResult> nodeDecisions,
                                               XContentBuilder builder,
                                               ToXContent.Params params)
                                        throws IOException

Generates X-Content for the node-level decisions, creating the outer "node_decisions" object in which they are serialized.

Throws:

IOException

atLeastOneNodeWithYesDecision

protected boolean atLeastOneNodeWithYesDecision()

Returns true if there is at least one node that returned a Decision.Type.YES decision for allocating this shard.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object