Class CompositeAggregationDescriptor<T>

A multi-bucket aggregation that creates composite buckets from different sources.

Inheritance
object
BucketAggregationDescriptorBase<CompositeAggregationDescriptor<T>, ICompositeAggregation, T>
CompositeAggregationDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CompositeAggregationDescriptor<T> : BucketAggregationDescriptorBase<CompositeAggregationDescriptor<T>, ICompositeAggregation, T>, IDescriptor, ICompositeAggregation, IBucketAggregation, IAggregation where T : class
Type Parameters
Name Description
T

Methods

| Edit this page View Source

After(CompositeKey)

Used to retrieve the composite buckets that are after the last composite buckets returned in a previous round

Declaration
public CompositeAggregationDescriptor<T> After(CompositeKey after)
Parameters
Type Name Description
CompositeKey after
Returns
Type Description
CompositeAggregationDescriptor<T>
| Edit this page View Source

Size(int?)

Defines how many composite buckets should be returned. Each composite bucket is considered as a single bucket so setting a size of 10 will return the first 10 composite buckets created from the values source.

Declaration
public CompositeAggregationDescriptor<T> Size(int? size)
Parameters
Type Name Description
int? size
Returns
Type Description
CompositeAggregationDescriptor<T>
| Edit this page View Source

Sources(Func<CompositeAggregationSourcesDescriptor<T>, IPromise<IList<ICompositeAggregationSource>>>)

Controls the sources that should be used to build the composite buckets

Declaration
public CompositeAggregationDescriptor<T> Sources(Func<CompositeAggregationSourcesDescriptor<T>, IPromise<IList<ICompositeAggregationSource>>> selector)
Parameters
Type Name Description
Func<CompositeAggregationSourcesDescriptor<T>, IPromise<IList<ICompositeAggregationSource>>> selector
Returns
Type Description
CompositeAggregationDescriptor<T>

Implements

Extension Methods