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

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PercentilesAggregation	build()	Builds a PercentilesAggregation.
final PercentilesAggregation.Builder	hdr(HdrMethod value)	Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles.
final PercentilesAggregation.Builder	hdr(Function<HdrMethod.Builder,ObjectBuilder<HdrMethod>> fn)	Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles.
final PercentilesAggregation.Builder	keyed(Boolean value)	By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array.
final PercentilesAggregation.Builder	percents(Double value, Double... values)	The percentiles to calculate.
final PercentilesAggregation.Builder	percents(List<Double> list)	The percentiles to calculate.
protected PercentilesAggregation.Builder	self()
final PercentilesAggregation.Builder	tdigest(TDigest value)	Sets parameters for the default TDigest algorithm used to calculate percentiles.
final PercentilesAggregation.Builder	tdigest(Function<TDigest.Builder,ObjectBuilder<TDigest>> fn)	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

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

keyed

public final PercentilesAggregation.Builder keyed(@Nullable
 Boolean value)

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 PercentilesAggregation.Builder percents(List<Double> list)

The percentiles to calculate.

API name: percents

Adds all elements of list to percents.

percents

public final PercentilesAggregation.Builder percents(Double value,
 Double... values)

The percentiles to calculate.

API name: percents

Adds one or more values to percents.

hdr

public final PercentilesAggregation.Builder hdr(@Nullable
 HdrMethod value)

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

public final PercentilesAggregation.Builder tdigest(@Nullable
 TDigest value)

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

protected PercentilesAggregation.Builder self()

Specified by:

self in class MetricAggregationBase.AbstractBuilder<PercentilesAggregation.Builder>

build

public PercentilesAggregation build()

Builds a PercentilesAggregation.

Specified by:

build in interface ObjectBuilder<PercentilesAggregation>

Throws:

NullPointerException - if some of the required fields are null.