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

Class TDigest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<TDigest.Builder>

co.elastic.clients.elasticsearch._types.aggregations.TDigest.Builder

All Implemented Interfaces:

WithJson<TDigest.Builder>, ObjectBuilder<TDigest>

Enclosing class:

TDigest

public static class TDigest.Builder
extends WithJsonObjectBuilderBase<TDigest.Builder>
implements ObjectBuilder<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.
final TDigest.Builder	executionHint(TDigestExecutionHint value)	The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).
protected TDigest.Builder	self()

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

compression

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

executionHint

public final TDigest.Builder executionHint(@Nullable
 TDigestExecutionHint value)

The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases). To use an implementation optimized for accuracy, set this parameter to high_accuracy instead.

API name: execution_hint

self

protected TDigest.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<TDigest.Builder>

build

public TDigest build()

Builds a TDigest.

Specified by:

build in interface ObjectBuilder<TDigest>

Throws:

NullPointerException - if some of the required fields are null.