Class MetricAggregationDescriptorBase<TMetricAggregation, TMetricAggregationInterface, T>

Inheritance
object
DescriptorBase<TMetricAggregation, TMetricAggregationInterface>
MetricAggregationDescriptorBase<TMetricAggregation, TMetricAggregationInterface, T>
CardinalityAggregationDescriptor<T>
FormattableMetricAggregationDescriptorBase<TFormattableMetricAggregation, TFormattableMetricAggregationInterface, T>
GeoBoundsAggregationDescriptor<T>
GeoCentroidAggregationDescriptor<T>
ScriptedMetricAggregationDescriptor<T>
TopHitsAggregationDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public abstract class MetricAggregationDescriptorBase<TMetricAggregation, TMetricAggregationInterface, T> : DescriptorBase<TMetricAggregation, TMetricAggregationInterface>, IDescriptor, IMetricAggregation, IAggregation where TMetricAggregation : MetricAggregationDescriptorBase<TMetricAggregation, TMetricAggregationInterface, T>, TMetricAggregationInterface, IMetricAggregation where TMetricAggregationInterface : class, IMetricAggregation where T : class
Type Parameters
Name Description
TMetricAggregation
TMetricAggregationInterface
T

Methods

| Edit this page View Source

Field(Field)

The field on which to aggregate

Declaration
public TMetricAggregation Field(Field field)
Parameters
Type Name Description
Field field
Returns
Type Description
TMetricAggregation
| Edit this page View Source

Field<TValue>(Expression<Func<T, TValue>>)

The field on which to aggregate

Declaration
public TMetricAggregation Field<TValue>(Expression<Func<T, TValue>> field)
Parameters
Type Name Description
Expression<Func<T, TValue>> field
Returns
Type Description
TMetricAggregation
Type Parameters
Name Description
TValue
| Edit this page View Source

Meta(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)

metadata to associate with the individual aggregation at request time that will be returned in place at response time

Declaration
public TMetricAggregation Meta(Func<FluentDictionary<string, object>, FluentDictionary<string, object>> selector)
Parameters
Type Name Description
Func<FluentDictionary<string, object>, FluentDictionary<string, object>> selector
Returns
Type Description
TMetricAggregation
| Edit this page View Source

Missing(double?)

The value to use when the aggregation finds a missing value in a document

Declaration
public TMetricAggregation Missing(double? missing)
Parameters
Type Name Description
double? missing
Returns
Type Description
TMetricAggregation
| Edit this page View Source

Script(Func<ScriptDescriptor, IScript>)

The script to use for the aggregation

Declaration
public virtual TMetricAggregation Script(Func<ScriptDescriptor, IScript> scriptSelector)
Parameters
Type Name Description
Func<ScriptDescriptor, IScript> scriptSelector
Returns
Type Description
TMetricAggregation
| Edit this page View Source

Script(string)

The script to use for the aggregation

Declaration
public virtual TMetricAggregation Script(string script)
Parameters
Type Name Description
string script
Returns
Type Description
TMetricAggregation

Implements

Extension Methods