Package org.opensearch.search.aggregations.metrics

Class ParsedSum

java.lang.Object

org.opensearch.search.aggregations.ParsedAggregation

org.opensearch.search.aggregations.metrics.ParsedSingleValueNumericMetricsAggregation

org.opensearch.search.aggregations.metrics.ParsedSum

All Implemented Interfaces:

org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, Aggregation, NumericMetricsAggregation, NumericMetricsAggregation.SingleValue, Sum

public class ParsedSum
extends ParsedSingleValueNumericMetricsAggregation
implements Sum

A sum agg result parsed between nodes

Opensearch.internal:

Nested Class Summary

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

Field Summary

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

value, valueAsString

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

metadata

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
ParsedSum()

Method Summary

Modifier and Type	Method	Description
protected org.opensearch.core.xcontent.XContentBuilder	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
static ParsedSum	fromXContent(org.opensearch.core.xcontent.XContentParser parser, String name)
String	getType()
double	getValue()	The sum.

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

declareSingleValueFields, getValueAsString, setValue, setValueAsString, value

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

declareAggregationFields, getMetadata, getName, parseDouble, setName, toXContent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getMetadata, getName

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

getValueAsString, value

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

toXContent

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

isFragment

Constructor Details

ParsedSum

public ParsedSum()

Method Details

getValue

public double getValue()

Description copied from interface: Sum

The sum.

Specified by:

getValue in interface Sum

getType

public String getType()

Specified by:

getType in interface Aggregation

Returns:

a string representing the type of the aggregation. This type is added to the aggregation name in the response, so that it can later be used by clients to determine type of the aggregation and parse it into the proper object.

doXContentBody

protected org.opensearch.core.xcontent.XContentBuilder doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                               throws IOException

Specified by:

doXContentBody in class ParsedAggregation

Throws:

IOException

fromXContent

public static ParsedSum fromXContent(org.opensearch.core.xcontent.XContentParser parser,
 String name)