Package org.opensearch.client.opensearch._types.aggregations

Class PercentilesAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase.AbstractBuilder<PercentilesAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.FormatMetricAggregationBase.AbstractBuilder<PercentilesAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.PercentilesAggregation.Builder

All Implemented Interfaces:

CopyableBuilder<PercentilesAggregation.Builder,PercentilesAggregation>, MutableBuilder<PercentilesAggregation.Builder,PercentilesAggregation>, ObjectBuilder<PercentilesAggregation>

Enclosing class:

PercentilesAggregation

public static class PercentilesAggregation.Builder
extends FormatMetricAggregationBase.AbstractBuilder<PercentilesAggregation.Builder>
implements CopyableBuilder<PercentilesAggregation.Builder,PercentilesAggregation>

Builder for PercentilesAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PercentilesAggregation	build()	Builds a PercentilesAggregation.
PercentilesAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PercentilesAggregation.Builder	hdr(Function<HdrMethod.Builder,ObjectBuilder<HdrMethod>> fn)	API name: hdr
final PercentilesAggregation.Builder	hdr(HdrMethod value)	API name: hdr
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(Function<TDigest.Builder,ObjectBuilder<TDigest>> fn)	API name: tdigest
final PercentilesAggregation.Builder	tdigest(TDigest value)	API name: tdigest

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.FormatMetricAggregationBase.AbstractBuilder

format

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase.AbstractBuilder

field, missing, missing, script, script

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public PercentilesAggregation.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<PercentilesAggregation.Builder,PercentilesAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected PercentilesAggregation.Builder self()

Specified by:

self in class MetricAggregationBase.AbstractBuilder<PercentilesAggregation.Builder>

hdr

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

API name: hdr

hdr

@Nonnull
public final PercentilesAggregation.Builder hdr(Function<HdrMethod.Builder,ObjectBuilder<HdrMethod>> fn)

API name: hdr

keyed

@Nonnull
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

@Nonnull
public final PercentilesAggregation.Builder percents(List<Double> list)

The percentiles to calculate.

API name: percents

Adds all elements of list to percents.

percents

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

The percentiles to calculate.

API name: percents

Adds one or more values to percents.

tdigest

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

API name: tdigest

tdigest

@Nonnull
public final PercentilesAggregation.Builder tdigest(Function<TDigest.Builder,ObjectBuilder<TDigest>> fn)

API name: tdigest

build

@Nonnull
public PercentilesAggregation build()

Builds a PercentilesAggregation.

Specified by:

build in interface ObjectBuilder<PercentilesAggregation>

Throws:

NullPointerException - if some of the required fields are null.