Class HistogramCompositeAggregationSourceDescriptor<T>

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

DescriptorBase<HistogramCompositeAggregationSourceDescriptor<T>, IHistogramCompositeAggregationSource>

CompositeAggregationSourceDescriptorBase<HistogramCompositeAggregationSourceDescriptor<T>, IHistogramCompositeAggregationSource, T>

HistogramCompositeAggregationSourceDescriptor<T>

Implements

IDescriptor

IHistogramCompositeAggregationSource

ICompositeAggregationSource

Inherited Members

CompositeAggregationSourceDescriptorBase<HistogramCompositeAggregationSourceDescriptor<T>, IHistogramCompositeAggregationSource, T>.Field(Field)

CompositeAggregationSourceDescriptorBase<HistogramCompositeAggregationSourceDescriptor<T>, IHistogramCompositeAggregationSource, T>.Field<TValue>(Expression<Func<T, TValue>>)

CompositeAggregationSourceDescriptorBase<HistogramCompositeAggregationSourceDescriptor<T>, IHistogramCompositeAggregationSource, T>.Order(SortOrder?)

CompositeAggregationSourceDescriptorBase<HistogramCompositeAggregationSourceDescriptor<T>, IHistogramCompositeAggregationSource, T>.MissingBucket(bool?)

DescriptorBase<HistogramCompositeAggregationSourceDescriptor<T>, IHistogramCompositeAggregationSource>.Self

DescriptorBase<HistogramCompositeAggregationSourceDescriptor<T>, IHistogramCompositeAggregationSource>.Assign<TValue>(TValue, Action<IHistogramCompositeAggregationSource, TValue>)

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 HistogramCompositeAggregationSourceDescriptor<T> : CompositeAggregationSourceDescriptorBase<HistogramCompositeAggregationSourceDescriptor<T>, IHistogramCompositeAggregationSource, T>, IDescriptor, IHistogramCompositeAggregationSource, ICompositeAggregationSource

Type Parameters

Name	Description
T

Constructors

HistogramCompositeAggregationSourceDescriptor(string)

Declaration

public HistogramCompositeAggregationSourceDescriptor(string name)

Parameters

Type	Name	Description
string	name

Methods

Interval(double?)

The interval to use when bucketing documents

Declaration

public HistogramCompositeAggregationSourceDescriptor<T> Interval(double? interval)

Parameters

Type	Name	Description
double?	interval

Returns

Type	Description
HistogramCompositeAggregationSourceDescriptor<T>

Script(Func<ScriptDescriptor, IScript>)

A script to create the values for the composite buckets

Declaration

public HistogramCompositeAggregationSourceDescriptor<T> Script(Func<ScriptDescriptor, IScript> selector)

Parameters

Type	Name	Description
Func<ScriptDescriptor, IScript>	selector

Returns

Type	Description
HistogramCompositeAggregationSourceDescriptor<T>

Implements

IDescriptor

IHistogramCompositeAggregationSource

ICompositeAggregationSource

Extension Methods

SuffixExtensions.Suffix(object, string)