Class BucketSortAggregation

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

AggregationBase

BucketSortAggregation

Implements

IBucketSortAggregation

IAggregation

Inherited Members

AggregationBase.Meta

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class BucketSortAggregation : AggregationBase, IBucketSortAggregation, IAggregation

Constructors

BucketSortAggregation(string)

Declaration

public BucketSortAggregation(string name)

Parameters

Type	Name	Description
string	name

Properties

From

Buckets in positions prior to the set value will be truncated

Declaration

public int? From { get; set; }

Property Value

Type	Description
int?

GapPolicy

The policy to apply when gaps are found in the data

Declaration

public GapPolicy? GapPolicy { get; set; }

Property Value

Type	Description
GapPolicy?

Size

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

Declaration

public int? Size { get; set; }

Property Value

Type	Description
int?

Sort

The list of fields to sort on

Declaration

public IList<ISort> Sort { get; set; }

Property Value

Type	Description
IList<ISort>

Implements

IBucketSortAggregation

IAggregation

Extension Methods

SuffixExtensions.Suffix(object, string)