Package org.elasticsearch.search.aggregations.metrics

Class ParsedTopHits

java.lang.Object
org.elasticsearch.search.aggregations.ParsedAggregation
org.elasticsearch.search.aggregations.metrics.ParsedTopHits
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, Aggregation, TopHits
public class ParsedTopHits extends ParsedAggregation implements TopHits

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

    Aggregation.CommonFields

    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

  • Field Summary

    Fields inherited from class org.elasticsearch.search.aggregations.ParsedAggregation

    metadata

    Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation

    TYPED_KEYS_DELIMITER

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    ParsedTopHits()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.elasticsearch.common.xcontent.XContentBuilder
    doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    static ParsedTopHits
    fromXContent(org.elasticsearch.common.xcontent.XContentParser parser, String name)
     
    SearchHits
    getHits()
     
    String
    getType()
     

    Methods inherited from class org.elasticsearch.search.aggregations.ParsedAggregation

    declareAggregationFields, getMetadata, getName, parseDouble, setName, toXContent

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

    getMetadata, getName

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

    toXContent

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

    isFragment

  • Constructor Details

    • ParsedTopHits

      public ParsedTopHits()

  • Method Details

    • getType

      public String getType()
      Specified by:
      getType in interface Aggregation
      Returns:
      a string representing the type of the aggregation. This type is added to the aggregation name in the response, so that it can later be used by clients to determine type of the aggregation and parse it into the proper object.

    • getHits

      public SearchHits getHits()
      Specified by:
      getHits in interface TopHits
      Returns:
      The top matching hits for the bucket

    • doXContentBody

      protected org.elasticsearch.common.xcontent.XContentBuilder doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      doXContentBody in class ParsedAggregation
      Throws:
      IOException

    • fromXContent

      public static ParsedTopHits fromXContent(org.elasticsearch.common.xcontent.XContentParser parser, String name) throws IOException
      Throws:
      IOException