Class CompositeAggregation

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

Inheritance

object

AggregationBase

BucketAggregationBase

CompositeAggregation

Implements

ICompositeAggregation

IBucketAggregation

IAggregation

Inherited Members

BucketAggregationBase.Aggregations

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 CompositeAggregation : BucketAggregationBase, ICompositeAggregation, IBucketAggregation, IAggregation

Constructors

CompositeAggregation(string)

Declaration

public CompositeAggregation(string name)

Parameters

Type	Name	Description
string	name

Properties

After

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

Declaration

public CompositeKey After { get; set; }

Property Value

Type	Description
CompositeKey

Size

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 int? Size { get; set; }

Property Value

Type	Description
int?

Sources

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

Declaration

public IEnumerable<ICompositeAggregationSource> Sources { get; set; }

Property Value

Type	Description
IEnumerable<ICompositeAggregationSource>

Implements

ICompositeAggregation

IBucketAggregation

IAggregation

Extension Methods

SuffixExtensions.Suffix(object, string)