org.elasticsearch.cluster.routing.allocation.decider

Class Decision.Single

java.lang.Object

org.elasticsearch.cluster.routing.allocation.decider.Decision

org.elasticsearch.cluster.routing.allocation.decider.Decision.Single

All Implemented Interfaces:

ToXContent

Enclosing class:

Decision

public static class Decision.Single
extends Decision

Simple class representing a single decision

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.cluster.routing.allocation.decider.Decision

Decision.Multi, Decision.Single, Decision.Type

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.cluster.routing.allocation.decider.Decision

ALWAYS, NO, THROTTLE, YES

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Decision.Single()
Decision.Single(Decision.Type type) Creates a new Decision.Single decision of a given type
Decision.Single(Decision.Type type, String label, String explanation, Object... explanationParams) Creates a new Decision.Single decision of a given type

Method Summary

Methods

Modifier and Type	Method and Description
String	getExplanation() Returns the explanation string, fully formatted.
String	label()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Decision.Type	type() Get the Decision.Type of this decision

Methods inherited from class org.elasticsearch.cluster.routing.allocation.decider.Decision

readFrom, single, writeTo

Methods inherited from class java.lang.Object

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

Constructor Detail

Decision.Single

public Decision.Single()

Decision.Single

public Decision.Single(Decision.Type type)

Creates a new Decision.Single decision of a given type

Parameters:

type - Decision.Type of the decision

Decision.Single

public Decision.Single(Decision.Type type,
               String label,
               String explanation,
               Object... explanationParams)

Creates a new Decision.Single decision of a given type

Parameters:

type - Decision.Type of the decision

explanation - An explanation of this Decision

explanationParams - A set of additional parameters

Method Detail

type

public Decision.Type type()

Description copied from class: Decision

Get the Decision.Type of this decision

Specified by:

type in class Decision

Returns:

Decision.Type of this decision

label

public String label()

Specified by:

label in class Decision

getExplanation

public String getExplanation()

Returns the explanation string, fully formatted. Only formats the string once

toString

public String toString()

Overrides:

toString in class Object

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Throws:

IOException