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

Class BoxplotAggregation.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase.AbstractBuilder<BoxplotAggregation.Builder>

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

All Implemented Interfaces:

WithJson<BoxplotAggregation.Builder>, ObjectBuilder<BoxplotAggregation>

Enclosing class:

BoxplotAggregation

public static class BoxplotAggregation.Builder
extends MetricAggregationBase.AbstractBuilder<BoxplotAggregation.Builder>
implements ObjectBuilder<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.
final BoxplotAggregation.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 BoxplotAggregation.Builder	self()

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase.AbstractBuilder

field, missing, missing, missing, missing, missing, missing, script, script

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

executionHint

public final BoxplotAggregation.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 BoxplotAggregation.Builder self()

Specified by:

self in class MetricAggregationBase.AbstractBuilder<BoxplotAggregation.Builder>

build

public BoxplotAggregation build()

Builds a BoxplotAggregation.

Specified by:

build in interface ObjectBuilder<BoxplotAggregation>

Throws:

NullPointerException - if some of the required fields are null.