Package org.elasticsearch.action.explain

Class ExplainResponse

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportResponse
org.elasticsearch.action.ActionResponse
org.elasticsearch.action.explain.ExplainResponse
All Implemented Interfaces:
Writeable, org.elasticsearch.common.util.concurrent.RefCounted, StatusToXContentObject, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class ExplainResponse
extends ActionResponse
implements StatusToXContentObject
Response containing the score explanation.

  • Nested Class Summary

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

    ActionResponse.Empty

    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

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

    Writeable.Reader<V>, Writeable.Writer<V>

  • Field Summary

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor Description
    ExplainResponse​(java.lang.String index, java.lang.String type, java.lang.String id, boolean exists)  
    ExplainResponse​(java.lang.String index, java.lang.String type, java.lang.String id, boolean exists, org.apache.lucene.search.Explanation explanation)  
    ExplainResponse​(java.lang.String index, java.lang.String type, java.lang.String id, boolean exists, org.apache.lucene.search.Explanation explanation, GetResult getResult)  
    ExplainResponse​(StreamInput in)  

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object obj)  
    static ExplainResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser, boolean exists)  
    org.apache.lucene.search.Explanation getExplanation()  
    GetResult getGetResult()  
    java.lang.String getId()  
    java.lang.String getIndex()  
    java.lang.String getType()
    Deprecated.
    Types are in the process of being removed.
    boolean hasExplanation()  
    int hashCode()  
    boolean isExists()  
    boolean isMatch()  
    RestStatus status()
    Returns the REST status to make sure it is returned correctly
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    void writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class org.elasticsearch.transport.TransportMessage

    decRef, incRef, remoteAddress, remoteAddress, tryIncRef

    Methods inherited from class java.lang.Object

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

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

    isFragment

  • Constructor Details

    • ExplainResponse

      public ExplainResponse​(java.lang.String index, java.lang.String type, java.lang.String id, boolean exists)

    • ExplainResponse

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

    • ExplainResponse

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

    • ExplainResponse

      public ExplainResponse​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

  • Method Details

    • getIndex

      public java.lang.String getIndex()

    • getType

      @Deprecated public java.lang.String getType()
      Deprecated.
      Types are in the process of being removed.

    • getId

      public java.lang.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 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​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException

    • fromXContent

      public static ExplainResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser, boolean exists)

    • 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

    • equals

      public boolean equals​(java.lang.Object obj)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object