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

Class BoxplotAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.aggregations.BoxplotAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

BoxplotAggregation

public static class BoxplotAggregation.Builder
extends MetricAggregationBase.AbstractBuilder<BoxplotAggregation.Builder>
implements CopyableBuilder<BoxplotAggregation.Builder,BoxplotAggregation>

Builder for BoxplotAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BoxplotAggregation	build()	Builds a BoxplotAggregation.
final BoxplotAggregation.Builder	compression(Double value)	Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error.
BoxplotAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
protected BoxplotAggregation.Builder	self()

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 BoxplotAggregation.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<BoxplotAggregation.Builder,BoxplotAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected BoxplotAggregation.Builder self()

Specified by:

self in class MetricAggregationBase.AbstractBuilder<BoxplotAggregation.Builder>

compression

@Nonnull
public final BoxplotAggregation.Builder compression(@Nullable
 Double value)

Limits the maximum number of nodes used by the underlying TDigest algorithm to 20 * compression, enabling control of memory usage and approximation error.

API name: compression

build

@Nonnull
public BoxplotAggregation build()

Builds a BoxplotAggregation.

Specified by:

build in interface ObjectBuilder<BoxplotAggregation>

Throws:

NullPointerException - if some of the required fields are null.