Package org.elasticsearch.cluster.routing.allocation

Class RoutingExplanations

java.lang.Object

org.elasticsearch.cluster.routing.allocation.RoutingExplanations

All Implemented Interfaces:

ToXContent, ToXContentFragment

public class RoutingExplanations
extends Object
implements ToXContentFragment

Class used to encapsulate a number of RerouteExplanation explanations.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RoutingExplanations()

Method Summary

Modifier and Type	Method	Description
RoutingExplanations	add(RerouteExplanation explanation)
List<RerouteExplanation>	explanations()
List<String>	getYesDecisionMessages()	Provides feedback from commands with a YES decision that should be displayed to the user after the command has been applied
static RoutingExplanations	readFrom(StreamInput in)	Read in a RoutingExplanations object
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
static void	writeTo(RoutingExplanations explanations, StreamOutput out)	Write the RoutingExplanations object

Methods inherited from class java.lang.Object

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

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

isFragment

Constructor Detail

RoutingExplanations

public RoutingExplanations()

Method Detail

add

public RoutingExplanations add(RerouteExplanation explanation)

explanations

public List<RerouteExplanation> explanations()

getYesDecisionMessages

public List<String> getYesDecisionMessages()

Provides feedback from commands with a YES decision that should be displayed to the user after the command has been applied

readFrom

public static RoutingExplanations readFrom(StreamInput in)
                                    throws IOException

Read in a RoutingExplanations object

Throws:

IOException

writeTo

public static void writeTo(RoutingExplanations explanations,
                           StreamOutput out)
                    throws IOException

Write the RoutingExplanations object

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException