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

Class PercentileRanksAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

org.opensearch.client.opensearch._types.aggregations.PercentileRanksAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

PercentileRanksAggregation

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

Builder for PercentileRanksAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Returns:

a new builder instance.

self

@Nonnull
protected PercentileRanksAggregation.Builder self()

Specified by:

self in class MetricAggregationBase.AbstractBuilder<PercentileRanksAggregation.Builder>

hdr

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

API name: hdr

hdr

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

API name: hdr

keyed

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

tdigest

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

API name: tdigest

tdigest

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

API name: tdigest

values

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

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

build

@Nonnull
public PercentileRanksAggregation build()

Builds a PercentileRanksAggregation.

Specified by:

build in interface ObjectBuilder<PercentileRanksAggregation>

Throws:

NullPointerException - if some of the required fields are null.