Class DiversifiedSamplerAggregation.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>
co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase.AbstractBuilder<DiversifiedSamplerAggregation.Builder>
co.elastic.clients.elasticsearch._types.aggregations.DiversifiedSamplerAggregation.Builder
- All Implemented Interfaces:
WithJson<DiversifiedSamplerAggregation.Builder>,ObjectBuilder<DiversifiedSamplerAggregation>
- Enclosing class:
- DiversifiedSamplerAggregation
public static class DiversifiedSamplerAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<DiversifiedSamplerAggregation.Builder>
implements ObjectBuilder<DiversifiedSamplerAggregation>
Builder for
DiversifiedSamplerAggregation.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aDiversifiedSamplerAggregation.The type of value used for de-duplication.The field used to provide values used for de-duplication.maxDocsPerValue(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 co.elastic.clients.util.WithJsonObjectBuilderBase
withJsonMethods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
executionHint
public final DiversifiedSamplerAggregation.Builder executionHint(@Nullable SamplerAggregationExecutionHint value) The type of value used for de-duplication.API name:
execution_hint -
maxDocsPerValue
Limits how many documents are permitted per choice of de-duplicating value.API name:
max_docs_per_value -
script
API name:script -
script
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 -
field
The field used to provide values used for de-duplication.API name:
field -
self
- Specified by:
selfin classBucketAggregationBase.AbstractBuilder<DiversifiedSamplerAggregation.Builder>
-
build
Builds aDiversifiedSamplerAggregation.- Specified by:
buildin interfaceObjectBuilder<DiversifiedSamplerAggregation>- Throws:
NullPointerException- if some of the required fields are null.
-