Class ExplainLifecycleResponse

All Implemented Interfaces:
Writeable, org.elasticsearch.core.RefCounted, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject

public class ExplainLifecycleResponse extends ActionResponse implements org.elasticsearch.xcontent.ToXContentObject
The response object returned by the Explain Lifecycle API.

Since the API can be run over multiple indices the response provides a map of index to the explanation of the lifecycle status for that index.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

    ActionResponse.Empty

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

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.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 final org.elasticsearch.xcontent.ParseField
     

    Fields inherited from interface org.elasticsearch.core.RefCounted

    ALWAYS_REFERENCED

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY, EMPTY_PARAMS
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
     
    int
     
     
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    void
    NB prior to 9.0 this was a TransportMasterNodeReadAction so for BwC we must remain able to write these responses until we no longer need to support calling this action remotely.

    Methods inherited from class org.elasticsearch.transport.TransportMessage

    decRef, hasReferences, incRef, tryIncRef

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.elasticsearch.core.RefCounted

    mustIncRef

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

    isFragment
  • Field Details

    • INDICES_FIELD

      public static final org.elasticsearch.xcontent.ParseField INDICES_FIELD
  • Constructor Details

  • Method Details

    • getIndexResponses

      public Map<String,IndexLifecycleExplainResponse> getIndexResponses()
      Returns:
      a map of the responses from each requested index. The maps key is the index name and the value is the IndexLifecycleExplainResponse describing the current lifecycle status of that index
    • toXContent

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException
    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      NB prior to 9.0 this was a TransportMasterNodeReadAction so for BwC we must remain able to write these responses until we no longer need to support calling this action remotely.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object