Class RareTermsAggregation
java.lang.Object
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
co.elastic.clients.elasticsearch._types.aggregations.RareTermsAggregation
- All Implemented Interfaces:
AggregationVariant
,JsonpSerializable
@JsonpDeserializable
public class RareTermsAggregation
extends BucketAggregationBase
implements AggregationVariant
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<RareTermsAggregation>
Json deserializer forRareTermsAggregation
-
Method Summary
Modifier and TypeMethodDescriptionAggregation variant kind.final TermsExclude
exclude()
Terms that should be excluded from the aggregation.final String
field()
The field from which to return rare terms.final TermsInclude
include()
Terms that should be included in the aggregation.final Long
The maximum number of documents a term should appear in.final FieldValue
missing()
The value to apply to documents that do not have a value.static RareTermsAggregation
final Double
The precision of the internal CuckooFilters.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final String
API name:value_type
Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
setupBucketAggregationBaseDeserializer
Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
meta, name, serialize, setupAggregationBaseDeserializer, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant
_toAggregation
-
Field Details
-
_DESERIALIZER
Json deserializer forRareTermsAggregation
-
-
Method Details
-
of
public static RareTermsAggregation of(Function<RareTermsAggregation.Builder, ObjectBuilder<RareTermsAggregation>> fn) -
_aggregationKind
Aggregation variant kind.- Specified by:
_aggregationKind
in interfaceAggregationVariant
-
exclude
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
-
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
-
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
-
serializeInternal
- Overrides:
serializeInternal
in classAggregationBase
-
setupRareTermsAggregationDeserializer
protected static void setupRareTermsAggregationDeserializer(ObjectDeserializer<RareTermsAggregation.Builder> op)
-