Search Results for

    Show / Hide Table of Contents

    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.

    Inherited Members
    IAggregation.Meta
    IAggregation.Name
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public interface IBucketSortAggregation : IAggregation

    Properties

    | Edit this page View Source

    From

    Buckets in positions prior to the set value will be truncated

    Declaration
    [DataMember(Name = "from")]
    int? From { get; set; }
    Property Value
    Type Description
    int?
    | Edit this page View Source

    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
    GapPolicy?
    | Edit this page View Source

    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?
    | Edit this page View Source

    Sort

    The list of fields to sort on

    Declaration
    [DataMember(Name = "sort")]
    IList<ISort> Sort { get; set; }
    Property Value
    Type Description
    IList<ISort>

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • From
      • GapPolicy
      • Size
      • Sort
    • Extension Methods
    Back to top Generated by DocFX