Package org.opensearch.search.aggregations.pipeline

Class InternalBucketMetricValue

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation

org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation.SingleValue

org.opensearch.search.aggregations.pipeline.InternalBucketMetricValue

All Implemented Interfaces:

NamedWriteable, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment, Aggregation, NumericMetricsAggregation, NumericMetricsAggregation.SingleValue, BucketMetricValue

public class InternalBucketMetricValue
extends InternalNumericMetricsAggregation.SingleValue
implements BucketMetricValue

Implementation of a bucket metric value

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation

InternalNumericMetricsAggregation.MultiValue, InternalNumericMetricsAggregation.SingleValue

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.InternalAggregation

InternalAggregation.ReduceContext, InternalAggregation.ReduceContextBuilder

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.Aggregation

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.metrics.NumericMetricsAggregation

NumericMetricsAggregation.MultiValue, NumericMetricsAggregation.SingleValue

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from class org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation

format

Fields inherited from class org.opensearch.search.aggregations.InternalAggregation

metadata, name

Fields inherited from interface org.opensearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InternalBucketMetricValue(String name, String[] keys, double value, DocValueFormat formatter, Map<String,Object> metadata)
InternalBucketMetricValue(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected void	doWriteTo(StreamOutput out)
org.opensearch.common.xcontent.XContentBuilder	doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
Object	getProperty(List<String> path)
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
String[]	keys()
InternalAggregation	reduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.
double	value()

Methods inherited from class org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation.SingleValue

getValueAsString, sortValue

Methods inherited from class org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation

mustReduceOnSingleInternalAgg, sortValue

Methods inherited from class org.opensearch.search.aggregations.InternalAggregation

copyWithRewritenBuckets, forEachBucket, getMetadata, getName, getProperty, getType, isMapped, mergePipelineTreeForBWCSerialization, pipelineAggregatorsForBwcSerialization, readSize, reducePipelines, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.search.aggregations.Aggregation

getMetadata, getName, getType

Methods inherited from interface org.opensearch.search.aggregations.metrics.NumericMetricsAggregation.SingleValue

getValueAsString

Methods inherited from interface org.opensearch.common.xcontent.ToXContent

toXContent

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

InternalBucketMetricValue

public InternalBucketMetricValue(String name,
 String[] keys,
 double value,
 DocValueFormat formatter,
 Map<String,Object> metadata)

InternalBucketMetricValue

public InternalBucketMetricValue(StreamInput in)
                          throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

value

public double value()

Specified by:

value in interface NumericMetricsAggregation.SingleValue

keys

public String[] keys()

Specified by:

keys in interface BucketMetricValue

reduce

public InternalAggregation reduce(List<InternalAggregation> aggregations,
 InternalAggregation.ReduceContext reduceContext)

Description copied from class: InternalAggregation

Reduces the given aggregations to a single one and returns it. In most cases, the assumption will be the all given aggregations are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing instance (typically the first in the given list) to save on redundant object construction.

Specified by:

reduce in class InternalAggregation

See Also:

• InternalAggregation.mustReduceOnSingleInternalAgg()

getProperty

public Object getProperty(List<String> path)

Overrides:

getProperty in class InternalNumericMetricsAggregation.SingleValue

doXContentBody

public org.opensearch.common.xcontent.XContentBuilder doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder,
 org.opensearch.common.xcontent.ToXContent.Params params)
                                                              throws IOException

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class InternalNumericMetricsAggregation

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalNumericMetricsAggregation