Class PercentileRanksAggregation
java.lang.Object
co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase
co.elastic.clients.elasticsearch._types.aggregations.FormatMetricAggregationBase
co.elastic.clients.elasticsearch._types.aggregations.PercentileRanksAggregation
- All Implemented Interfaces:
AggregationVariant
,JsonpSerializable
@JsonpDeserializable
public class PercentileRanksAggregation
extends FormatMetricAggregationBase
implements AggregationVariant
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.aggregations.FormatMetricAggregationBase
FormatMetricAggregationBase.AbstractBuilder<BuilderT extends FormatMetricAggregationBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<PercentileRanksAggregation>
Json deserializer forPercentileRanksAggregation
-
Method Summary
Modifier and TypeMethodDescriptionAggregation variant kind.final HdrMethod
hdr()
Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks.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 PercentileRanksAggregation
protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
setupPercentileRanksAggregationDeserializer
(ObjectDeserializer<PercentileRanksAggregation.Builder> op) final TDigest
tdigest()
Sets parameters for the default TDigest algorithm used to calculate percentile ranks.values()
An array of values for which to calculate the percentile ranks.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
Json deserializer forPercentileRanksAggregation
-
-
Method Details
-
of
public static PercentileRanksAggregation of(Function<PercentileRanksAggregation.Builder, ObjectBuilder<PercentileRanksAggregation>> fn) -
_aggregationKind
Aggregation variant kind.- Specified by:
_aggregationKind
in interfaceAggregationVariant
-
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 tofalse
to disable this behavior.API name:
keyed
-
values
An array of values for which to calculate the percentile ranks.API name:
values
-
hdr
Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks.API name:
hdr
-
tdigest
Sets parameters for the default TDigest algorithm used to calculate percentile ranks.API name:
tdigest
-
serializeInternal
- Overrides:
serializeInternal
in classFormatMetricAggregationBase
-
setupPercentileRanksAggregationDeserializer
protected static void setupPercentileRanksAggregationDeserializer(ObjectDeserializer<PercentileRanksAggregation.Builder> op)
-