Class ShardAllocationDecision
java.lang.Object
org.elasticsearch.cluster.routing.allocation.ShardAllocationDecision
- All Implemented Interfaces:
Writeable
,ToXContent
,ToXContentFragment
public final class ShardAllocationDecision extends java.lang.Object implements ToXContentFragment, Writeable
Represents the decision taken for the allocation of a single shard. If
the shard is unassigned,
getAllocateDecision()
will return an
object containing the decision and its explanation, and getMoveDecision()
will return an object for which MoveDecision.isDecisionTaken()
returns
false
. If the shard is in the started state, then getMoveDecision()
will return an object containing the decision to move/rebalance the shard, and
getAllocateDecision()
will return an object for which
AllocateUnassignedDecision.isDecisionTaken()
returns false
. If
the shard is neither unassigned nor started (i.e. it is initializing or relocating),
then both getAllocateDecision()
and getMoveDecision()
will return
objects whose isDecisionTaken()
method returns false
.-
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 static ShardAllocationDecision
NOT_TAKEN
-
Constructor Summary
Constructors Constructor Description ShardAllocationDecision(AllocateUnassignedDecision allocateDecision, MoveDecision moveDecision)
ShardAllocationDecision(StreamInput in)
-
Method Summary
Modifier and Type Method Description AllocateUnassignedDecision
getAllocateDecision()
Gets the unassigned allocation decision for the shard.MoveDecision
getMoveDecision()
Gets the move decision for the shard.boolean
isDecisionTaken()
Returnstrue
if either an allocation decision or a move decision was taken for the shard.XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.
-
Field Details
-
Constructor Details
-
ShardAllocationDecision
public ShardAllocationDecision(AllocateUnassignedDecision allocateDecision, MoveDecision moveDecision) -
ShardAllocationDecision
- Throws:
java.io.IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
isDecisionTaken
public boolean isDecisionTaken()Returnstrue
if either an allocation decision or a move decision was taken for the shard. If no decision was taken, as in the case of initializing or relocating shards, then this method returnsfalse
. -
getAllocateDecision
Gets the unassigned allocation decision for the shard. If the shard was not in the unassigned state, the instance ofAllocateUnassignedDecision
that is returned will haveAllocateUnassignedDecision.isDecisionTaken()
returnfalse
. -
getMoveDecision
Gets the move decision for the shard. If the shard was not in the started state, the instance ofMoveDecision
that is returned will haveMoveDecision.isDecisionTaken()
returnfalse
. -
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-