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 -
Method Summary
Modifier and TypeMethodDescriptionThe target number of buckets.build()Builds aVariableWidthHistogramAggregation.copy()Create a new builderCopyableBuilderthat is a copy of this one.API name:fieldinitialBuffer(Integer value) Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run.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, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<VariableWidthHistogramAggregation.Builder,VariableWidthHistogramAggregation> - Returns:
- a new builder instance.
-
buckets
The target number of buckets.API name:
buckets -
field
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 tomin(10 * shard_size, 50000).API name:
initial_buffer -
shardSize
The number of buckets that the coordinating node will request from each shard. Defaults tobuckets * 50.API name:
shard_size -
build
Builds aVariableWidthHistogramAggregation.- Specified by:
buildin interfaceObjectBuilder<VariableWidthHistogramAggregation>- Throws:
NullPointerException- if some of the required fields are null.
-