Class MetricAggregationBase

Inheritance

object

AggregationBase

MetricAggregationBase

CardinalityAggregation

FormattableMetricAggregationBase

GeoBoundsAggregation

GeoCentroidAggregation

ScriptedMetricAggregation

TopHitsAggregation

Implements

IMetricAggregation

IAggregation

Inherited Members

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 abstract class MetricAggregationBase : AggregationBase, IMetricAggregation, IAggregation

Constructors

MetricAggregationBase(string, Field)

Declaration

protected MetricAggregationBase(string name, Field field)

Parameters

Type	Name	Description
string	name
Field	field

Properties

Field

The field on which to aggregate

Declaration

public Field Field { get; set; }

Property Value

Type	Description
Field

Missing

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

Declaration

public double? Missing { get; set; }

Property Value

Type	Description
double?

Script

The script to use for the aggregation

Declaration

public virtual IScript Script { get; set; }

Property Value

Type	Description
IScript

Implements

IMetricAggregation

IAggregation

Extension Methods

SuffixExtensions.Suffix(object, string)