Package co.elastic.clients.elasticsearch._types.aggregations

Class PercentilesAggregation

java.lang.Object

co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase

co.elastic.clients.elasticsearch._types.aggregations.FormatMetricAggregationBase

co.elastic.clients.elasticsearch._types.aggregations.PercentilesAggregation

All Implemented Interfaces:

AggregationVariant, JsonpSerializable

@JsonpDeserializable
public class PercentilesAggregation
extends FormatMetricAggregationBase
implements AggregationVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PercentilesAggregation.Builder	Builder for PercentilesAggregation.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.aggregations.FormatMetricAggregationBase

FormatMetricAggregationBase.AbstractBuilder<BuilderT extends FormatMetricAggregationBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
final HdrMethod	hdr()	Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles.
final Boolean	keyed()	By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array.
static PercentilesAggregation	of(Function<PercentilesAggregation.Builder,ObjectBuilder<PercentilesAggregation>> fn)
final List<Double>	percents()	The percentiles to calculate.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPercentilesAggregationDeserializer(ObjectDeserializer<PercentilesAggregation.Builder> op)
final TDigest	tdigest()	Sets parameters for the default TDigest algorithm used to calculate percentiles.

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.FormatMetricAggregationBase

format, setupFormatMetricAggregationBaseDeserializer

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase

field, missing, script, serialize, setupMetricAggregationBaseDeserializer, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant

_toAggregation

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PercentilesAggregation> _DESERIALIZER

Json deserializer for PercentilesAggregation

Method Details

of

public static PercentilesAggregation of(Function<PercentilesAggregation.Builder,ObjectBuilder<PercentilesAggregation>> fn)

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

keyed

@Nullable
public final Boolean keyed()

By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array. Set to false to disable this behavior.

API name: keyed

percents

public final List<Double> percents()

The percentiles to calculate.

API name: percents

hdr

@Nullable
public final HdrMethod hdr()

Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles.

API name: hdr

tdigest

@Nullable
public final TDigest tdigest()

Sets parameters for the default TDigest algorithm used to calculate percentiles.

API name: tdigest

serializeInternal

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

Overrides:

serializeInternal in class FormatMetricAggregationBase

setupPercentilesAggregationDeserializer

protected static void setupPercentilesAggregationDeserializer(ObjectDeserializer<PercentilesAggregation.Builder> op)