Class PercentilesAggregation.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase.AbstractBuilder<BuilderT>
co.elastic.clients.elasticsearch._types.aggregations.FormatMetricAggregationBase.AbstractBuilder<PercentilesAggregation.Builder>
co.elastic.clients.elasticsearch._types.aggregations.PercentilesAggregation.Builder
- All Implemented Interfaces:
WithJson<PercentilesAggregation.Builder>
,ObjectBuilder<PercentilesAggregation>
- Enclosing class:
- PercentilesAggregation
public static class PercentilesAggregation.Builder
extends FormatMetricAggregationBase.AbstractBuilder<PercentilesAggregation.Builder>
implements ObjectBuilder<PercentilesAggregation>
Builder for
PercentilesAggregation
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aPercentilesAggregation
.Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles.Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles.By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array.The percentiles to calculate.The percentiles to calculate.protected PercentilesAggregation.Builder
self()
Sets parameters for the default TDigest algorithm used to calculate percentiles.Sets parameters for the default TDigest algorithm used to calculate percentiles.Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.FormatMetricAggregationBase.AbstractBuilder
format
Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase.AbstractBuilder
field, missing, missing, missing, missing, missing, missing, script, script
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
-
percents
The percentiles to calculate.API name:
percents
Adds all elements of
list
topercents
. -
percents
The percentiles to calculate.API name:
percents
Adds one or more values to
percents
. -
hdr
Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles.API name:
hdr
-
hdr
public final PercentilesAggregation.Builder hdr(Function<HdrMethod.Builder, ObjectBuilder<HdrMethod>> fn) Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles.API name:
hdr
-
tdigest
Sets parameters for the default TDigest algorithm used to calculate percentiles.API name:
tdigest
-
tdigest
public final PercentilesAggregation.Builder tdigest(Function<TDigest.Builder, ObjectBuilder<TDigest>> fn) Sets parameters for the default TDigest algorithm used to calculate percentiles.API name:
tdigest
-
self
- Specified by:
self
in classMetricAggregationBase.AbstractBuilder<PercentilesAggregation.Builder>
-
build
Builds aPercentilesAggregation
.- Specified by:
build
in interfaceObjectBuilder<PercentilesAggregation>
- Throws:
NullPointerException
- if some of the required fields are null.
-