Class BucketSortAggregationDescriptor<T>

A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation. Zero or more sort fields may be specified together with the corresponding sort order. Each bucket may be sorted based on its _key, _count or its sub-aggregations. In addition, parameters from and size may be set in order to truncate the result buckets.

Inheritance
object
DescriptorBase<BucketSortAggregationDescriptor<T>, IBucketSortAggregation>
BucketSortAggregationDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class BucketSortAggregationDescriptor<T> : DescriptorBase<BucketSortAggregationDescriptor<T>, IBucketSortAggregation>, IDescriptor, IBucketSortAggregation, IAggregation where T : class
Type Parameters
Name Description
T

Methods

| Edit this page View Source

From(int?)

Buckets in positions prior to the set value will be truncated

Declaration
public BucketSortAggregationDescriptor<T> From(int? from)
Parameters
Type Name Description
int? from
Returns
Type Description
BucketSortAggregationDescriptor<T>
| Edit this page View Source

GapPolicy(GapPolicy?)

The policy to apply when gaps are found in the data

Declaration
public BucketSortAggregationDescriptor<T> GapPolicy(GapPolicy? gapPolicy)
Parameters
Type Name Description
GapPolicy? gapPolicy
Returns
Type Description
BucketSortAggregationDescriptor<T>
| Edit this page View Source

Meta(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)

The metadata for the aggregation

Declaration
public BucketSortAggregationDescriptor<T> Meta(Func<FluentDictionary<string, object>, FluentDictionary<string, object>> selector)
Parameters
Type Name Description
Func<FluentDictionary<string, object>, FluentDictionary<string, object>> selector
Returns
Type Description
BucketSortAggregationDescriptor<T>
| Edit this page View Source

Size(int?)

The number of buckets to return. Defaults to all buckets of the parent aggregation

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

Sort(Func<SortDescriptor<T>, IPromise<IList<ISort>>>)

The list of fields to sort on

Declaration
public BucketSortAggregationDescriptor<T> Sort(Func<SortDescriptor<T>, IPromise<IList<ISort>>> selector)
Parameters
Type Name Description
Func<SortDescriptor<T>, IPromise<IList<ISort>>> selector
Returns
Type Description
BucketSortAggregationDescriptor<T>

Implements

Extension Methods