Interface IBucketSortAggregation
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.
Namespace: OpenSearch .Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IBucketSortAggregation : IAggregationProperties
| Edit this page View SourceFrom
Buckets in positions prior to the set value will be truncated
Declaration
[DataMember(Name = "from")]
int? From { get; set; }Property Value
| Type | Description |
|---|---|
| int? |
GapPolicy
The policy to apply when gaps are found in the data
Declaration
[DataMember(Name = "gap_policy")]
GapPolicy? GapPolicy { get; set; }Property Value
| Type | Description |
|---|---|
| Gap |
Size
The number of buckets to return. Defaults to all buckets of the parent aggregation
Declaration
[DataMember(Name = "size")]
int? Size { get; set; }Property Value
| Type | Description |
|---|---|
| int? |
Sort
The list of fields to sort on
Declaration
[DataMember(Name = "sort")]
IList<ISort> Sort { get; set; }