Package org.elasticsearch.cluster.routing.allocation

Class RoutingExplanations

java.lang.Object
org.elasticsearch.cluster.routing.allocation.RoutingExplanations
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
public class RoutingExplanations
extends java.lang.Object
implements org.elasticsearch.common.xcontent.ToXContentFragment
Class used to encapsulate a number of RerouteExplanation explanations.

  • Nested Class Summary

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

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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)  
    java.util.List<RerouteExplanation> explanations()  
    java.util.List<java.lang.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
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.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 Details

    • RoutingExplanations

      public RoutingExplanations()

  • Method Details

    • add

      public RoutingExplanations add​(RerouteExplanation explanation)

    • explanations

      public java.util.List<RerouteExplanation> explanations()

    • getYesDecisionMessages

      public java.util.List<java.lang.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 java.io.IOException
      Read in a RoutingExplanations object
      Throws:
      java.io.IOException

    • writeTo

      public static void writeTo​(RoutingExplanations explanations, StreamOutput out) throws java.io.IOException
      Write the RoutingExplanations object
      Throws:
      java.io.IOException

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException