Class WeightedAverageValue

Inheritance

object

WeightedAverageValue

Implements

IWeightedAverageValue

Inherited Members

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 WeightedAverageValue : IWeightedAverageValue

Constructors

WeightedAverageValue(Field)

Declaration

public WeightedAverageValue(Field field)

Parameters

Type	Name	Description
Field	field

WeightedAverageValue(IScript)

Declaration

public WeightedAverageValue(IScript script)

Parameters

Type	Name	Description
IScript	script

Properties

Field

The field that values should be extracted from

Declaration

public Field Field { get; set; }

Property Value

Type	Description
Field

Missing

defines how documents that are missing a value should be treated. The default behavior is different for value and weight: By default, if the value field is missing the document is ignored and the aggregation moves on to the next document. If the weight field is missing, it is assumed to have a weight of 1 (like a normal average).

Declaration

public double? Missing { get; set; }

Property Value

Type	Description
double?

Script

A script to derive the value and the weight from

Declaration

public IScript Script { get; set; }

Property Value

Type	Description
IScript

Implements

IWeightedAverageValue

Extension Methods

SuffixExtensions.Suffix(object, string)