Class HistogramCompositeAggregationSource

A value source that can be applied on numeric values to build fixed size interval over the values. The interval parameter defines how the numeric values should be transformed. For instance an interval set to 5 will translate any numeric values to its closest interval, a value of 101 would be translated to 100 which is the key for the interval between 100 and 105.

Inheritance

object

CompositeAggregationSourceBase

HistogramCompositeAggregationSource

Implements

IHistogramCompositeAggregationSource

ICompositeAggregationSource

Inherited Members

CompositeAggregationSourceBase.Field

CompositeAggregationSourceBase.MissingBucket

CompositeAggregationSourceBase.Order

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 HistogramCompositeAggregationSource : CompositeAggregationSourceBase, IHistogramCompositeAggregationSource, ICompositeAggregationSource

Constructors

HistogramCompositeAggregationSource(string)

Declaration

public HistogramCompositeAggregationSource(string name)

Parameters

Type	Name	Description
string	name

Properties

Interval

The interval to use when bucketing documents

Declaration

public double? Interval { get; set; }

Property Value

Type	Description
double?

Script

A script to create the values for the composite buckets

Declaration

public IScript Script { get; set; }

Property Value

Type	Description
IScript

SourceType

The type of the source

Declaration

protected override string SourceType { get; }

Property Value

Type	Description
string

Overrides

CompositeAggregationSourceBase.SourceType

Implements

IHistogramCompositeAggregationSource

ICompositeAggregationSource

Extension Methods

SuffixExtensions.Suffix(object, string)