Package org.elasticsearch.action.explain

Class ExplainResponse

org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportResponse
org.elasticsearch.action.ActionResponse
org.elasticsearch.action.explain.ExplainResponse
All Implemented Interfaces:
Writeable, StatusToXContentObject, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.core.RefCounted
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
     index,  type,  id, boolean exists)
     
     index,  type,  id, boolean exists, org.apache.lucene.search.Explanation explanation)
     
     index,  type,  id, boolean exists, org.apache.lucene.search.Explanation explanation, GetResult getResult)
     
    ExplainResponse​(StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     obj)
     
    static ExplainResponse
    fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser, boolean exists)
     
    org.apache.lucene.search.Explanation
    getExplanation()
     
    GetResult
    getGetResult()
     
    getId()
     
    getIndex()
     
    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.

    , , , , , , , ,

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

    isFragment

  • Constructor Details

    • ExplainResponse

      public ExplainResponse​( index,  type,  id, boolean exists)

    • ExplainResponse

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

    • ExplainResponse

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

    • ExplainResponse

      public ExplainResponse​(StreamInput in) throws
      Throws:

  • Method Details

    • getIndex

      public  getIndex()

    • getType

      public  getType()
      Deprecated.
      Types are in the process of being removed.

    • getId

      public  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
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:

    • 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
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:

    • equals

      public boolean equals​( obj)
      Overrides:
       in class 

    • hashCode

      public int hashCode()
      Overrides:
       in class