Class PercentileRanksAggregation.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<PercentileRanksAggregation.Builder>
co.elastic.clients.elasticsearch._types.aggregations.PercentileRanksAggregation.Builder
- All Implemented Interfaces:
WithJson<PercentileRanksAggregation.Builder>
,ObjectBuilder<PercentileRanksAggregation>
- Enclosing class:
- PercentileRanksAggregation
public static class PercentileRanksAggregation.Builder
extends FormatMetricAggregationBase.AbstractBuilder<PercentileRanksAggregation.Builder>
implements ObjectBuilder<PercentileRanksAggregation>
Builder for
PercentileRanksAggregation
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aPercentileRanksAggregation
.Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks.Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks.By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array.protected PercentileRanksAggregation.Builder
self()
Sets parameters for the default TDigest algorithm used to calculate percentile ranks.Sets parameters for the default TDigest algorithm used to calculate percentile ranks.An array of values for which to calculate the percentile ranks.An array of values for which to calculate the percentile ranks.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
-
values
An array of values for which to calculate the percentile ranks.API name:
values
Adds all elements of
list
tovalues
. -
values
An array of values for which to calculate the percentile ranks.API name:
values
Adds one or more values to
values
. -
hdr
Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks.API name:
hdr
-
hdr
public final PercentileRanksAggregation.Builder hdr(Function<HdrMethod.Builder, ObjectBuilder<HdrMethod>> fn) 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
-
tdigest
public final PercentileRanksAggregation.Builder tdigest(Function<TDigest.Builder, ObjectBuilder<TDigest>> fn) Sets parameters for the default TDigest algorithm used to calculate percentile ranks.API name:
tdigest
-
self
- Specified by:
self
in classMetricAggregationBase.AbstractBuilder<PercentileRanksAggregation.Builder>
-
build
Builds aPercentileRanksAggregation
.- Specified by:
build
in interfaceObjectBuilder<PercentileRanksAggregation>
- Throws:
NullPointerException
- if some of the required fields are null.
-