Package org.opensearch.search.aggregations

Builds analytic information over all hits in a search request.

Interface Summary

Interface	Description
Aggregation	An aggregation.
Aggregator.BucketComparator	Compare two buckets by their ordinal.
Aggregator.Parser	Parses the aggregation request and creates the appropriate aggregator factory for it.
BaseAggregationBuilder	Interface shared by AggregationBuilder and PipelineAggregationBuilder so they can conveniently share the same namespace for XContentParser.namedObject(Class, String, Object).
HasAggregations
InternalAggregation.ReduceContextBuilder	Builds InternalAggregation.ReduceContext.
KeyComparable<T extends MultiBucketsAggregation.Bucket & KeyComparable<T>>	Defines behavior for comparing bucket keys to imposes a total ordering of buckets of the same type.

Class Summary

Class	Description
AbstractAggregationBuilder<AB extends AbstractAggregationBuilder<AB>>	Base implementation of a AggregationBuilder.
Aggregation.CommonFields	Common xcontent fields that are shared among addAggregation
AggregationBuilder	A factory that knows how to create an Aggregator of a specific type.
AggregationBuilder.CommonFields	Common xcontent fields shared among aggregator builders
AggregationBuilders	Utility class to create aggregations.
AggregationPhase	Aggregation phase of a search request, used to collect aggregations
Aggregations	Represents a set of Aggregations
Aggregator	An Aggregator.
AggregatorBase	Base implementation for concrete aggregators.
AggregatorFactories	An immutable collection of AggregatorFactories.
AggregatorFactories.Builder	A mutable collection of AggregationBuilders and PipelineAggregationBuilders.
AggregatorFactory
BucketCollector	A Collector that can collect data in separate buckets.
BucketOrder	MultiBucketsAggregation.Bucket ordering strategy.
CardinalityUpperBound	Upper bound of how many owningBucketOrds that an Aggregator will have to collect into.
InternalAggregation	An internal implementation of Aggregation.
InternalAggregation.ReduceContext
InternalAggregations	An internal implementation of Aggregations.
InternalMultiBucketAggregation<A extends InternalMultiBucketAggregation,B extends InternalMultiBucketAggregation.InternalBucket>
InternalMultiBucketAggregation.InternalBucket
InternalOrder	Implementations for MultiBucketsAggregation.Bucket ordering strategies.
InternalOrder.Aggregation	MultiBucketsAggregation.Bucket ordering strategy to sort by a sub-aggregation.
InternalOrder.CompoundOrder	MultiBucketsAggregation.Bucket ordering strategy to sort by multiple criteria.
InternalOrder.Parser	Contains logic for parsing a BucketOrder from a XContentParser.
InternalOrder.Streams	Contains logic for reading/writing BucketOrder from/to streams.
LeafBucketCollector	Per-leaf bucket collector.
LeafBucketCollectorBase	A LeafBucketCollector that delegates all calls to the sub leaf aggregator and sets the scorer on its source of values if it implements ScorerAware.
MultiBucketCollector	A BucketCollector which allows running a bucket collection with several BucketCollectors.
MultiBucketConsumerService	An aggregation service that creates instances of MultiBucketConsumerService.MultiBucketConsumer.
MultiBucketConsumerService.MultiBucketConsumer	An IntConsumer that throws a MultiBucketConsumerService.TooManyBucketsException when the sum of the provided values is above the limit (`search.max_buckets`).
NonCollectingAggregator	An aggregator that is not collected, this can typically be used when running an aggregation over a field that doesn't have a mapping.
ParsedAggregation	An implementation of Aggregation that is parsed from a REST response.
ParsedMultiBucketAggregation<B extends MultiBucketsAggregation.Bucket>
ParsedMultiBucketAggregation.ParsedBucket
PipelineAggregationBuilder	A factory that knows how to create an PipelineAggregator of a specific type.
PipelineAggregationBuilder.ValidationContext
PipelineAggregatorBuilders
SearchContextAggregations	The aggregation context that is part of the search context.

Enum Summary

Enum	Description
AggregationBuilder.BucketCardinality	A rough count of the number of buckets that Aggregators built by this builder will contain per parent bucket used to validate sorts and pipeline aggregations.
Aggregator.SubAggCollectionMode	Aggregation mode for sub aggregations.

Exception Summary

Exception	Description
AggregationExecutionException	Thrown when failing to execute an aggregation
AggregationInitializationException	Thrown when failing to execute an aggregation
InvalidAggregationPathException
MultiBucketConsumerService.TooManyBucketsException