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

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PercentileRanksAggregation	build()	Builds a PercentileRanksAggregation.
final PercentileRanksAggregation.Builder	hdr(HdrMethod value)	Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks.
final PercentileRanksAggregation.Builder	hdr(Function<HdrMethod.Builder,ObjectBuilder<HdrMethod>> fn)	Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks.
final PercentileRanksAggregation.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.
protected PercentileRanksAggregation.Builder	self()
final PercentileRanksAggregation.Builder	tdigest(TDigest value)	Sets parameters for the default TDigest algorithm used to calculate percentile ranks.
final PercentileRanksAggregation.Builder	tdigest(Function<TDigest.Builder,ObjectBuilder<TDigest>> fn)	Sets parameters for the default TDigest algorithm used to calculate percentile ranks.
final PercentileRanksAggregation.Builder	values(Double value, Double... values)	An array of values for which to calculate the percentile ranks.
final PercentileRanksAggregation.Builder	values(List<Double> list)	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

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 PercentileRanksAggregation.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

values

public final PercentileRanksAggregation.Builder values(List<Double> list)

An array of values for which to calculate the percentile ranks.

API name: values

Adds all elements of list to values.

values

public final PercentileRanksAggregation.Builder values(Double value,
 Double... values)

An array of values for which to calculate the percentile ranks.

API name: values

Adds one or more values to values.

hdr

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

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

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

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

protected PercentileRanksAggregation.Builder self()

Specified by:

self in class MetricAggregationBase.AbstractBuilder<PercentileRanksAggregation.Builder>

build

public PercentileRanksAggregation build()

Builds a PercentileRanksAggregation.

Specified by:

build in interface ObjectBuilder<PercentileRanksAggregation>

Throws:

NullPointerException - if some of the required fields are null.