Class Decision
java.lang.Object
org.opensearch.cluster.routing.allocation.decider.Decision
- All Implemented Interfaces:
Writeable
,org.opensearch.common.xcontent.ToXContent
- Direct Known Subclasses:
Decision.Multi
,Decision.Single
public abstract class Decision extends java.lang.Object implements org.opensearch.common.xcontent.ToXContent, Writeable
This abstract class defining basic
Decision
used during shard
allocation process.- See Also:
AllocationDecider
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Decision.Multi
Simple class representing a list of decisionsstatic class
Decision.Single
Simple class representing a single decisionstatic class
Decision.Type
This enumeration defines the possible types of decisionsNested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent
org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
-
Constructor Summary
Constructors Constructor Description Decision()
-
Method Summary
Modifier and Type Method Description abstract java.util.List<Decision>
getDecisions()
Return the list of all decisions that make up this decisionabstract java.lang.String
getExplanation()
Get the explanation for this decision.abstract java.lang.String
label()
Get the description label for this decision.static Decision
readFrom(StreamInput in)
static Decision
single(Decision.Type type, java.lang.String label, java.lang.String explanation, java.lang.Object... explanationParams)
Creates a simple decisionabstract Decision.Type
type()
Get theDecision.Type
of this decision
-
Field Details
-
Constructor Details
-
Decision
public Decision()
-
-
Method Details
-
single
public static Decision single(Decision.Type type, @Nullable java.lang.String label, @Nullable java.lang.String explanation, @Nullable java.lang.Object... explanationParams)Creates a simple decision- Parameters:
type
-Decision.Type
of the decisionlabel
- label for the Decider that produced this decisionexplanation
- explanation of the decisionexplanationParams
- additional parameters for the decision- Returns:
- new
Decision
instance
-
readFrom
- Throws:
java.io.IOException
-
type
Get theDecision.Type
of this decision- Returns:
Decision.Type
of this decision
-
label
@Nullable public abstract java.lang.String label()Get the description label for this decision. -
getExplanation
@Nullable public abstract java.lang.String getExplanation()Get the explanation for this decision. -
getDecisions
Return the list of all decisions that make up this decision
-