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

Class TDigest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.TDigest.Builder

All Implemented Interfaces:

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

Enclosing class:

TDigest

public static class TDigest.Builder
extends ObjectBuilderBase
implements CopyableBuilder<TDigest.Builder,TDigest>

Builder for TDigest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

Returns:

a new builder instance.

compression

@Nonnull
public final TDigest.Builder compression(@Nullable
 Integer 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 TDigest build()

Builds a TDigest.

Specified by:

build in interface ObjectBuilder<TDigest>

Throws:

NullPointerException - if some of the required fields are null.