Package org.opensearch.search.aggregations

Class InternalOrder.Aggregation

java.lang.Object
org.opensearch.search.aggregations.BucketOrder
org.opensearch.search.aggregations.InternalOrder
org.opensearch.search.aggregations.InternalOrder.Aggregation
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject
Enclosing class:
InternalOrder
public static class InternalOrder.Aggregation extends InternalOrder
MultiBucketsAggregation.Bucket ordering strategy to sort by a sub-aggregation.
Opensearch.internal:

  • Method Details

    • path

      public AggregationPath path()

    • partiallyBuiltBucketComparator

      public <T extends MultiBucketsAggregation.Bucket> Comparator<T> partiallyBuiltBucketComparator(ToLongFunction<T> ordinalReader, Aggregator aggregator)
      Description copied from class: BucketOrder
      A builds comparator comparing buckets partially built buckets by delegating comparison of the results of any "child" aggregations to the provided Aggregator.

      Warning: This is fairly difficult to use and impossible to use cleanly. In addition, this exists primarily to return the "top n" buckets based on the results of a sub aggregation. The trouble is that could end up throwing away buckets on the data nodes that should ultimately be kept after reducing all of the results. If you know that this is coming it is fine, but most folks that use "generic" sorts don't. In other words: before you use this method think super duper hard if you want to have these kinds of issues. The terms agg does an folks get into trouble with it all the time.

      Specified by:
      partiallyBuiltBucketComparator in class BucketOrder

    • comparator

      public Comparator<MultiBucketsAggregation.Bucket> comparator()
      Description copied from class: BucketOrder
      Build a comparator for fully built buckets.
      Specified by:
      comparator in class BucketOrder

    • toXContent

      public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Throws:
      IOException

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in class BucketOrder

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in class BucketOrder