Class RareTermsAggregation.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<RareTermsAggregation.Builder>
co.elastic.clients.elasticsearch._types.aggregations.RareTermsAggregation.Builder
- All Implemented Interfaces:
WithJson<RareTermsAggregation.Builder>
,ObjectBuilder<RareTermsAggregation>
- Enclosing class:
- RareTermsAggregation
public static class RareTermsAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<RareTermsAggregation.Builder>
implements ObjectBuilder<RareTermsAggregation>
Builder for
RareTermsAggregation
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aRareTermsAggregation
.exclude
(TermsExclude value) Terms that should be excluded from the aggregation.Terms that should be excluded from the aggregation.The field from which to return rare terms.include
(TermsInclude value) Terms that should be included in the aggregation.Terms that should be included in the aggregation.maxDocCount
(Long value) The maximum number of documents a term should appear in.missing
(boolean value) The value to apply to documents that do not have a value.missing
(double value) The value to apply to documents that do not have a value.missing
(long value) The value to apply to documents that do not have a value.missing
(FieldValue value) The value to apply to documents that do not have a value.The value to apply to documents that do not have a value.The value to apply to documents that do not have a value.The precision of the internal CuckooFilters.protected RareTermsAggregation.Builder
self()
API name:value_type
Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder
meta, meta, name
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
exclude
Terms that should be excluded from the aggregation.API name:
exclude
-
exclude
public final RareTermsAggregation.Builder exclude(Function<TermsExclude.Builder, ObjectBuilder<TermsExclude>> fn) Terms that should be excluded from the aggregation.API name:
exclude
-
field
The field from which to return rare terms.API name:
field
-
include
Terms that should be included in the aggregation.API name:
include
-
include
public final RareTermsAggregation.Builder include(Function<TermsInclude.Builder, ObjectBuilder<TermsInclude>> fn) Terms that should be included in the aggregation.API name:
include
-
maxDocCount
The maximum number of documents a term should appear in.API name:
max_doc_count
-
missing
The value to apply to documents that do not have a value. By default, documents without a value are ignored.API name:
missing
-
missing
public final RareTermsAggregation.Builder missing(Function<FieldValue.Builder, ObjectBuilder<FieldValue>> fn) The value to apply to documents that do not have a value. By default, documents without a value are ignored.API name:
missing
-
missing
The value to apply to documents that do not have a value. By default, documents without a value are ignored.API name:
missing
-
missing
The value to apply to documents that do not have a value. By default, documents without a value are ignored.API name:
missing
-
missing
The value to apply to documents that do not have a value. By default, documents without a value are ignored.API name:
missing
-
missing
The value to apply to documents that do not have a value. By default, documents without a value are ignored.API name:
missing
-
precision
The precision of the internal CuckooFilters. Smaller precision leads to better approximation, but higher memory usage.API name:
precision
-
valueType
API name:value_type
-
self
- Specified by:
self
in classAggregationBase.AbstractBuilder<RareTermsAggregation.Builder>
-
build
Builds aRareTermsAggregation
.- Specified by:
build
in interfaceObjectBuilder<RareTermsAggregation>
- Throws:
NullPointerException
- if some of the required fields are null.
-