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, PlainJsonSerializable

Direct Known Subclasses:

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

@Generated("org.opensearch.client.codegen.CodeGenerator")
public abstract class SingleMetricAggregateBase
extends AggregateBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
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
boolean	equals(Object o)
int	hashCode()
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <BuilderT extends SingleMetricAggregateBase.AbstractBuilder<BuilderT>> void	setupSingleMetricAggregateBaseDeserializer(ObjectDeserializer<BuilderT> op)
final Double	value()	The metric value.
final 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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Constructor Details

SingleMetricAggregateBase

protected SingleMetricAggregateBase(SingleMetricAggregateBase.AbstractBuilder<?> builder)

Method Details

value

@Nullable
public final Double value()

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

API name: value

valueAsString

@Nullable
public final 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)

hashCode

public int hashCode()

Overrides:

hashCode in class AggregateBase

equals

public boolean equals(Object o)

Overrides:

equals in class AggregateBase