Package org.opensearch.client.opensearch._types.aggregations

Class SingleMetricAggregateBase

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregateBase

org.opensearch.client.opensearch._types.aggregations.SingleMetricAggregateBase

All Implemented Interfaces:

JsonpSerializable

Direct Known Subclasses:

AvgAggregate, BucketMetricValueAggregate, DerivativeAggregate, MaxAggregate, MedianAbsoluteDeviationAggregate, MinAggregate, SimpleValueAggregate, SumAggregate, ValueCountAggregate, WeightedAvgAggregate

public abstract class SingleMetricAggregateBase
extends AggregateBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	SingleMetricAggregateBase.AbstractBuilder<BuilderT extends SingleMetricAggregateBase.AbstractBuilder<BuilderT>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SingleMetricAggregateBase(SingleMetricAggregateBase.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <BuilderT extends SingleMetricAggregateBase.AbstractBuilder<BuilderT>> void	setupSingleMetricAggregateBaseDeserializer(ObjectDeserializer<BuilderT> op)
double	value()	Required - The metric value.
java.lang.String	valueAsString()	API name: value_as_string

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregateBase

meta, serialize, setupAggregateBaseDeserializer

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleMetricAggregateBase

protected SingleMetricAggregateBase(SingleMetricAggregateBase.AbstractBuilder<?> builder)

Method Detail

value

public final double value()

Required - The metric value. A missing value generally means that there was no data to aggregate, unless specified otherwise.

API name: value

Defaults to 0 if parsed from a JSON null value.

valueAsString

@Nullable
public final java.lang.String valueAsString()

API name: value_as_string

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

Overrides:

serializeInternal in class AggregateBase

setupSingleMetricAggregateBaseDeserializer

protected static <BuilderT extends SingleMetricAggregateBase.AbstractBuilder<BuilderT>> void setupSingleMetricAggregateBaseDeserializer(ObjectDeserializer<BuilderT> op)