Class RankEvalResponse

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportResponse
org.elasticsearch.action.ActionResponse
org.elasticsearch.index.rankeval.RankEvalResponse
All Implemented Interfaces:
org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.core.RefCounted

public class RankEvalResponse extends org.elasticsearch.action.ActionResponse implements org.elasticsearch.common.xcontent.ToXContentObject
Returns the results for a RankEvalRequest.
The response contains a detailed section for each evaluation query in the request and possible failures that happened when execution individual queries.
  • Nested Class Summary

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

    org.elasticsearch.action.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

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends Object>
  • Field Summary

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

    EMPTY_PARAMS
  • Constructor Summary

    Constructors
    Constructor
    Description
    RankEvalResponse​(double metricScore, Map<String,​EvalQueryQuality> partialResults, Map<String,​Exception> failures)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
     
     
    double
     
     
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    void
    writeTo​(org.elasticsearch.common.io.stream.StreamOutput out)
     

    Methods inherited from class org.elasticsearch.transport.TransportMessage

    decRef, incRef, remoteAddress, remoteAddress, tryIncRef

    Methods inherited from class java.lang.Object

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

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

    isFragment
  • Constructor Details

  • Method Details

    • getMetricScore

      public double getMetricScore()
    • getPartialResults

      public Map<String,​EvalQueryQuality> getPartialResults()
    • getFailures

      public Map<String,​Exception> getFailures()
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • writeTo

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

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

      public static RankEvalResponse fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException