Package org.opensearch.search.aggregations.pipeline

Class InternalStatsBucket

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation

org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation.MultiValue

org.opensearch.search.aggregations.metrics.InternalStats

org.opensearch.search.aggregations.pipeline.InternalStatsBucket

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, Aggregation, NumericMetricsAggregation, NumericMetricsAggregation.MultiValue, Stats, StatsBucket

public class InternalStatsBucket
extends InternalStats
implements StatsBucket

Implementation of stats pipeline

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.core.xcontent.ToXContent

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

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

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

count, max, min, sum

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.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InternalStatsBucket(String name, long count, double sum, double min, double max, DocValueFormat formatter, Map<String,Object> metadata)
InternalStatsBucket(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
String	getWriteableName()
InternalStats	reduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.

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

doWriteTo, doXContentBody, equals, getAvg, getAvgAsString, getCount, getMax, getMaxAsString, getMin, getMinAsString, getSum, getSumAsString, hashCode, otherStatsToXContent, value, writeOtherStatsTo

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

getProperty, sortValue, valueAsString

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.Stats

getAvg, getAvgAsString, getCount, getMax, getMaxAsString, getMin, getMinAsString, getSum, getSumAsString

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

toXContent

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

isFragment

Constructor Details

InternalStatsBucket

public InternalStatsBucket(String name,
 long count,
 double sum,
 double min,
 double max,
 DocValueFormat formatter,
 Map<String,Object> metadata)

InternalStatsBucket

public InternalStatsBucket(org.opensearch.core.common.io.stream.StreamInput in)
                    throws IOException

Read from a stream.

Throws:

IOException

Method Details

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.NamedWriteable

Overrides:

getWriteableName in class InternalStats

reduce

public InternalStats 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.

Overrides:

reduce in class InternalStats

See Also:

• InternalAggregation.mustReduceOnSingleInternalAgg()