Package org.opensearch.search.aggregations.metrics

Interface TopHits

All Superinterfaces:
Aggregation, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment
All Known Implementing Classes:
InternalTopHits, ParsedTopHits
public interface TopHits extends Aggregation
Accumulation of the most relevant hits for a bucket this aggregation falls into.
Opensearch.internal:

  • Nested Class Summary

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

    Aggregation.CommonFields

    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

  • Field Summary

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

    TYPED_KEYS_DELIMITER

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

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type
    Method
    Description
    SearchHits
    getHits()
     

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

    getMetadata, getName, getType

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

    toXContent

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

    isFragment

  • Method Details

    • getHits

      SearchHits getHits()
      Returns:
      The top matching hits for the bucket