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

Class VariableWidthHistogramAggregation.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

All Implemented Interfaces:

WithJson<VariableWidthHistogramAggregation.Builder>, ObjectBuilder<VariableWidthHistogramAggregation>

Enclosing class:

VariableWidthHistogramAggregation

public static class VariableWidthHistogramAggregation.Builder
extends WithJsonObjectBuilderBase<VariableWidthHistogramAggregation.Builder>
implements ObjectBuilder<VariableWidthHistogramAggregation>

Builder for VariableWidthHistogramAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final VariableWidthHistogramAggregation.Builder	buckets(Integer value)	The target number of buckets.
VariableWidthHistogramAggregation	build()	Builds a VariableWidthHistogramAggregation.
final VariableWidthHistogramAggregation.Builder	field(String value)	The name of the field.
final VariableWidthHistogramAggregation.Builder	initialBuffer(Integer value)	Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run.
protected VariableWidthHistogramAggregation.Builder	self()
final VariableWidthHistogramAggregation.Builder	shardSize(Integer value)	The number of buckets that the coordinating node will request from each shard.

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

field

public final VariableWidthHistogramAggregation.Builder field(@Nullable
 String value)

The name of the field.

API name: field

buckets

public final VariableWidthHistogramAggregation.Builder buckets(@Nullable
 Integer value)

The target number of buckets.

API name: buckets

shardSize

public final VariableWidthHistogramAggregation.Builder shardSize(@Nullable
 Integer value)

The number of buckets that the coordinating node will request from each shard. Defaults to buckets * 50.

API name: shard_size

initialBuffer

public final VariableWidthHistogramAggregation.Builder initialBuffer(@Nullable
 Integer value)

Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run. Defaults to min(10 * shard_size, 50000).

API name: initial_buffer

self

protected VariableWidthHistogramAggregation.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<VariableWidthHistogramAggregation.Builder>

build

public VariableWidthHistogramAggregation build()

Builds a VariableWidthHistogramAggregation.

Specified by:

build in interface ObjectBuilder<VariableWidthHistogramAggregation>

Throws:

NullPointerException - if some of the required fields are null.