Class DiversifiedSamplerAggregation.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<DiversifiedSamplerAggregation.Builder>
org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<DiversifiedSamplerAggregation.Builder>
org.opensearch.client.opensearch._types.aggregations.DiversifiedSamplerAggregation.Builder
- All Implemented Interfaces:
CopyableBuilder<DiversifiedSamplerAggregation.Builder,,DiversifiedSamplerAggregation> MutableBuilder<DiversifiedSamplerAggregation.Builder,,DiversifiedSamplerAggregation> ObjectBuilder<DiversifiedSamplerAggregation>
- Enclosing class:
DiversifiedSamplerAggregation
public static class DiversifiedSamplerAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<DiversifiedSamplerAggregation.Builder>
implements CopyableBuilder<DiversifiedSamplerAggregation.Builder,DiversifiedSamplerAggregation>
Builder for
DiversifiedSamplerAggregation.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aDiversifiedSamplerAggregation.copy()Create a new builderCopyableBuilderthat is a copy of this one.API name:execution_hintAPI name:fieldmaxDocsPerValue(Integer value) Limits how many documents are permitted per choice of de-duplicating value.API name:scriptAPI name:scriptprotected DiversifiedSamplerAggregation.Builderself()Limits how many top-scoring documents are collected in the sample processed on each shard.Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder
meta, meta, nameMethods 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<DiversifiedSamplerAggregation.Builder,DiversifiedSamplerAggregation> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classAggregationBase.AbstractBuilder<DiversifiedSamplerAggregation.Builder>
-
executionHint
@Nonnull public final DiversifiedSamplerAggregation.Builder executionHint(@Nullable SamplerAggregationExecutionHint value) API name:execution_hint -
field
API name:field -
maxDocsPerValue
@Nonnull public final DiversifiedSamplerAggregation.Builder maxDocsPerValue(@Nullable Integer value) Limits how many documents are permitted per choice of de-duplicating value.API name:
max_docs_per_value -
script
API name:script -
script
@Nonnull public final DiversifiedSamplerAggregation.Builder script(Function<Script.Builder, ObjectBuilder<Script>> fn) API name:script -
shardSize
Limits how many top-scoring documents are collected in the sample processed on each shard.API name:
shard_size -
build
Builds aDiversifiedSamplerAggregation.- Specified by:
buildin interfaceObjectBuilder<DiversifiedSamplerAggregation>- Throws:
NullPointerException- if some of the required fields are null.
-