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

Class VariableWidthHistogramAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.VariableWidthHistogramAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

VariableWidthHistogramAggregation

public static class VariableWidthHistogramAggregation.Builder
extends ObjectBuilderBase
implements CopyableBuilder<VariableWidthHistogramAggregation.Builder,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.
VariableWidthHistogramAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final VariableWidthHistogramAggregation.Builder	field(String value)	API name: 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.
final VariableWidthHistogramAggregation.Builder	shardSize(Integer value)	The number of buckets that the coordinating node will request from each shard.

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

Returns:

a new builder instance.

buckets

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

The target number of buckets.

API name: buckets

field

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

API name: field

initialBuffer

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

shardSize

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

build

@Nonnull
public VariableWidthHistogramAggregation build()

Builds a VariableWidthHistogramAggregation.

Specified by:

build in interface ObjectBuilder<VariableWidthHistogramAggregation>

Throws:

NullPointerException - if some of the required fields are null.