Package org.opensearch.action.admin.cluster.allocation

Class ClusterAllocationExplainResponse

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.core.transport.TransportResponse
org.opensearch.core.action.ActionResponse
org.opensearch.action.admin.cluster.allocation.ClusterAllocationExplainResponse
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable
@PublicApi(since="1.0.0") public class ClusterAllocationExplainResponse extends org.opensearch.core.action.ActionResponse
Explanation response for a shard in the cluster
Opensearch.api:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.opensearch.core.transport.TransportResponse

    org.opensearch.core.transport.TransportResponse.Empty

    Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

    org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClusterAllocationExplainResponse(ClusterAllocationExplanation cae)
     
    ClusterAllocationExplainResponse(org.opensearch.core.common.io.stream.StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    ClusterAllocationExplanation
    getExplanation()
    Return the explanation for shard allocation in the cluster
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

    Methods inherited from class org.opensearch.core.transport.TransportMessage

    remoteAddress, remoteAddress

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ClusterAllocationExplainResponse

      public ClusterAllocationExplainResponse(org.opensearch.core.common.io.stream.StreamInput in) throws IOException
      Throws:
      IOException

    • ClusterAllocationExplainResponse

      public ClusterAllocationExplainResponse(ClusterAllocationExplanation cae)

  • Method Details

    • getExplanation

      public ClusterAllocationExplanation getExplanation()
      Return the explanation for shard allocation in the cluster

    • writeTo

      public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Throws:
      IOException