Package org.opensearch.search.aggregations.metrics

Class InternalNumericMetricsAggregation

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation

All Implemented Interfaces:

NamedWriteable, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment, Aggregation

Direct Known Subclasses:

InternalNumericMetricsAggregation.MultiValue, InternalNumericMetricsAggregation.SingleValue

public abstract class InternalNumericMetricsAggregation
extends InternalAggregation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InternalNumericMetricsAggregation.MultiValue
static class	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.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
protected DocValueFormat	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

Modifier	Constructor	Description
protected	InternalNumericMetricsAggregation(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
int	hashCode()
protected boolean	mustReduceOnSingleInternalAgg()	Signal the framework if the InternalAggregation.reduce(List, ReduceContext) phase needs to be called when there is only one InternalAggregation.
double	sortValue(AggregationPath.PathElement head, java.util.Iterator<AggregationPath.PathElement> tail)	Get value to use when sorting by a descendant of this aggregation.

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

copyWithRewritenBuckets, doWriteTo, doXContentBody, forEachBucket, getMetadata, getName, getProperty, getProperty, getType, isMapped, mergePipelineTreeForBWCSerialization, pipelineAggregatorsForBwcSerialization, readSize, reduce, reducePipelines, sortValue, 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.common.io.stream.NamedWriteable

getWriteableName

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

isFragment

Field Details

format

protected DocValueFormat format

Constructor Details

InternalNumericMetricsAggregation

protected InternalNumericMetricsAggregation(StreamInput in) throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Details

sortValue

public final double sortValue(AggregationPath.PathElement head, java.util.Iterator<AggregationPath.PathElement> tail)

Description copied from class: InternalAggregation

Get value to use when sorting by a descendant of this aggregation.

Overrides:

sortValue in class InternalAggregation

mustReduceOnSingleInternalAgg

protected boolean mustReduceOnSingleInternalAgg()

Description copied from class: InternalAggregation

Signal the framework if the InternalAggregation.reduce(List, ReduceContext) phase needs to be called when there is only one InternalAggregation.

Specified by:

mustReduceOnSingleInternalAgg in class InternalAggregation

hashCode

public int hashCode()

Overrides:

hashCode in class InternalAggregation

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class InternalAggregation