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

Class StatsAggregate

java.lang.Object

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

org.opensearch.client.opensearch._types.aggregations.StatsAggregate

All Implemented Interfaces:

JsonpSerializable, AggregateVariant

Direct Known Subclasses:

ExtendedStatsAggregate, StatsBucketAggregate

@JsonpDeserializable
public class StatsAggregate
extends AggregateBase
implements AggregateVariant

Statistics aggregation result. min, max and avg are missing if there were no values to process (count is zero).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	StatsAggregate.AbstractBuilder<BuilderT extends StatsAggregate.AbstractBuilder<BuilderT>>
static class	StatsAggregate.Builder	Builder for StatsAggregate.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<StatsAggregate>	_DESERIALIZER	Json deserializer for StatsAggregate

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Aggregate.Kind	_aggregateKind()	Aggregate variant kind.
double	avg()	Required - API name: avg
java.lang.String	avgAsString()	API name: avg_as_string
long	count()	Required - API name: count
double	max()	Required - API name: max
java.lang.String	maxAsString()	API name: max_as_string
double	min()	Required - API name: min
java.lang.String	minAsString()	API name: min_as_string
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <BuilderT extends StatsAggregate.AbstractBuilder<BuilderT>> void	setupStatsAggregateDeserializer(ObjectDeserializer<BuilderT> op)
static StatsAggregate	statsAggregateOf(java.util.function.Function<StatsAggregate.Builder,ObjectBuilder<StatsAggregate>> fn)
double	sum()	Required - API name: sum
java.lang.String	sumAsString()	API name: sum_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

Methods inherited from interface org.opensearch.client.opensearch._types.aggregations.AggregateVariant

_toAggregate

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<StatsAggregate> _DESERIALIZER

Json deserializer for StatsAggregate

Constructor Detail

StatsAggregate

protected StatsAggregate(StatsAggregate.AbstractBuilder<?> builder)

Method Detail

statsAggregateOf

public static StatsAggregate statsAggregateOf(java.util.function.Function<StatsAggregate.Builder,ObjectBuilder<StatsAggregate>> fn)

_aggregateKind

public Aggregate.Kind _aggregateKind()

Aggregate variant kind.

Specified by:

_aggregateKind in interface AggregateVariant

count

public final long count()

Required - API name: count

min

public final double min()

Required - API name: min

Defaults to Double.POSITIVE_INFINITY if parsed from a JSON null value.

max

public final double max()

Required - API name: max

Defaults to Double.NEGATIVE_INFINITY if parsed from a JSON null value.

avg

public final double avg()

Required - API name: avg

Defaults to 0 if parsed from a JSON null value.

sum

public final double sum()

Required - API name: sum

minAsString

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

API name: min_as_string

maxAsString

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

API name: max_as_string

avgAsString

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

API name: avg_as_string

sumAsString

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

API name: sum_as_string

serializeInternal

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

Overrides:

serializeInternal in class AggregateBase

setupStatsAggregateDeserializer

protected static <BuilderT extends StatsAggregate.AbstractBuilder<BuilderT>> void setupStatsAggregateDeserializer(ObjectDeserializer<BuilderT> op)