Class TermsAggregation
java.lang.Object
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
co.elastic.clients.elasticsearch._types.aggregations.TermsAggregation
- All Implemented Interfaces:
AggregationVariant
,PivotGroupByVariant
,JsonpSerializable
@JsonpDeserializable
public class TermsAggregation
extends BucketAggregationBase
implements AggregationVariant, PivotGroupByVariant
- 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<TermsAggregation>
Json deserializer forTermsAggregation
-
Method Summary
Modifier and TypeMethodDescriptionAggregation variant kind.PivotGroupBy variant kind.Determines how child aggregations should be calculated: breadth-first or depth-first.final TermsExclude
exclude()
Values to exclude.Determines whether the aggregation will use field values directly or global ordinals.final String
field()
The field from which to return terms.final String
format()
API name:format
final TermsInclude
include()
Values to include.final Integer
Only return values that are found in more thanmin_doc_count
hits.final FieldValue
missing()
The value to apply to documents that do not have a value.final Boolean
API name:missing_bucket
final MissingOrder
API name:missing_order
static TermsAggregation
final List<NamedValue<SortOrder>>
order()
Specifies the sort order of the buckets.final Script
script()
API name:script
protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final Integer
The number of candidate terms produced by each shard.final Boolean
Set totrue
to return thedoc_count_error_upper_bound
, which is an upper bound to the error on thedoc_count
returned by each shard.final Integer
size()
The number of buckets returned out of the overall terms list.final String
Coerced unmapped fields into the specified 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
Methods inherited from interface co.elastic.clients.elasticsearch.transform.PivotGroupByVariant
_toPivotGroupBy
-
Field Details
-
_DESERIALIZER
Json deserializer forTermsAggregation
-
-
Method Details
-
of
public static TermsAggregation of(Function<TermsAggregation.Builder, ObjectBuilder<TermsAggregation>> fn) -
_aggregationKind
Aggregation variant kind.- Specified by:
_aggregationKind
in interfaceAggregationVariant
-
_pivotGroupByKind
PivotGroupBy variant kind.- Specified by:
_pivotGroupByKind
in interfacePivotGroupByVariant
-
collectMode
Determines how child aggregations should be calculated: breadth-first or depth-first.API name:
collect_mode
-
exclude
Values to exclude. Accepts regular expressions and partitions.API name:
exclude
-
executionHint
Determines whether the aggregation will use field values directly or global ordinals.API name:
execution_hint
-
field
The field from which to return terms.API name:
field
-
include
Values to include. Accepts regular expressions and partitions.API name:
include
-
minDocCount
Only return values that are found in more thanmin_doc_count
hits.API name:
min_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
-
missingOrder
API name:missing_order
-
missingBucket
API name:missing_bucket
-
valueType
Coerced unmapped fields into the specified type.API name:
value_type
-
order
Specifies the sort order of the buckets. Defaults to sorting by descending document count.API name:
order
-
script
API name:script
-
shardSize
The number of candidate terms produced by each shard. By default,shard_size
will be automatically estimated based on the number of shards and thesize
parameter.API name:
shard_size
-
showTermDocCountError
Set totrue
to return thedoc_count_error_upper_bound
, which is an upper bound to the error on thedoc_count
returned by each shard.API name:
show_term_doc_count_error
-
size
The number of buckets returned out of the overall terms list.API name:
size
-
format
API name:format
-
serializeInternal
- Overrides:
serializeInternal
in classAggregationBase
-
setupTermsAggregationDeserializer
protected static void setupTermsAggregationDeserializer(ObjectDeserializer<TermsAggregation.Builder> op)
-