Class MultiTermsAggregation
java.lang.Object
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
co.elastic.clients.elasticsearch._types.aggregations.MultiTermsAggregation
- All Implemented Interfaces:
AggregationVariant
,JsonpSerializable
@JsonpDeserializable
public class MultiTermsAggregation
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<MultiTermsAggregation>
Json deserializer forMultiTermsAggregation
-
Method Summary
Modifier and TypeMethodDescriptionAggregation variant kind.Specifies the strategy for data collection.final Long
The minimum number of documents in a bucket for it to be returned.static MultiTermsAggregation
final List<NamedValue<SortOrder>>
order()
Specifies the sort order of the buckets.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final Long
The minimum number of documents in a bucket on each shard for it to be returned.final Integer
The number of candidate terms produced by each shard.final Boolean
Calculates the doc count error on per term basis.final Integer
size()
The number of term buckets should be returned out of the overall terms list.final List<MultiTermLookup>
terms()
Required - The field from which to generate sets of terms.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 forMultiTermsAggregation
-
-
Method Details
-
of
public static MultiTermsAggregation of(Function<MultiTermsAggregation.Builder, ObjectBuilder<MultiTermsAggregation>> fn) -
_aggregationKind
Aggregation variant kind.- Specified by:
_aggregationKind
in interfaceAggregationVariant
-
collectMode
Specifies the strategy for data collection.API name:
collect_mode
-
order
Specifies the sort order of the buckets. Defaults to sorting by descending document count.API name:
order
-
minDocCount
The minimum number of documents in a bucket for it to be returned.API name:
min_doc_count
-
shardMinDocCount
The minimum number of documents in a bucket on each shard for it to be returned.API name:
shard_min_doc_count
-
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
Calculates the doc count error on per term basis.API name:
show_term_doc_count_error
-
size
The number of term buckets should be returned out of the overall terms list.API name:
size
-
terms
Required - The field from which to generate sets of terms.API name:
terms
-
serializeInternal
- Overrides:
serializeInternal
in classAggregationBase
-
setupMultiTermsAggregationDeserializer
protected static void setupMultiTermsAggregationDeserializer(ObjectDeserializer<MultiTermsAggregation.Builder> op)
-