Package org.opensearch.action.explain

Class ExplainResponse

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.core.transport.TransportResponse
org.opensearch.core.action.ActionResponse
org.opensearch.action.explain.ExplainResponse
All Implemented Interfaces:
StatusToXContentObject, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject
@PublicApi(since="1.0.0") public class ExplainResponse extends org.opensearch.core.action.ActionResponse implements StatusToXContentObject
Response containing the score explanation.
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.xcontent.ToXContent

    org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

    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>

  • Field Summary

    Fields inherited from interface org.opensearch.core.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExplainResponse(String index, String id, boolean exists)
     
    ExplainResponse(String index, String id, boolean exists, org.apache.lucene.search.Explanation explanation)
     
    ExplainResponse(String index, String id, boolean exists, org.apache.lucene.search.Explanation explanation, GetResult getResult)
     
    ExplainResponse(org.opensearch.core.common.io.stream.StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static ExplainResponse
    fromXContent(org.opensearch.core.xcontent.XContentParser parser, boolean exists)
     
    org.apache.lucene.search.Explanation
    getExplanation()
     
    GetResult
    getGetResult()
     
    String
    getId()
     
    String
    getIndex()
     
    boolean
    hasExplanation()
     
    int
    hashCode()
     
    boolean
    isExists()
     
    boolean
    isMatch()
     
    org.opensearch.core.rest.RestStatus
    status()
    Returns the REST status to make sure it is returned correctly
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

    isFragment

  • Constructor Details

    • ExplainResponse

      public ExplainResponse(String index, String id, boolean exists)

    • ExplainResponse

      public ExplainResponse(String index, String id, boolean exists, org.apache.lucene.search.Explanation explanation)

    • ExplainResponse

      public ExplainResponse(String index, String id, boolean exists, org.apache.lucene.search.Explanation explanation, GetResult getResult)

    • ExplainResponse

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

  • Method Details

    • getIndex

      public String getIndex()

    • getId

      public String getId()

    • getExplanation

      public org.apache.lucene.search.Explanation getExplanation()

    • isMatch

      public boolean isMatch()

    • hasExplanation

      public boolean hasExplanation()

    • isExists

      public boolean isExists()

    • getGetResult

      public GetResult getGetResult()

    • status

      public org.opensearch.core.rest.RestStatus status()
      Description copied from interface: StatusToXContentObject
      Returns the REST status to make sure it is returned correctly
      Specified by:
      status in interface StatusToXContentObject

    • writeTo

      public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.opensearch.core.common.io.stream.Writeable
      Throws:
      IOException

    • fromXContent

      public static ExplainResponse fromXContent(org.opensearch.core.xcontent.XContentParser parser, boolean exists)

    • toXContent

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

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object