Class MultiTermsAggregation
java.lang.Object
org.opensearch.client.opensearch._types.aggregations.AggregationBase
org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase
org.opensearch.client.opensearch._types.aggregations.MultiTermsAggregation
- All Implemented Interfaces:
JsonpSerializable,PlainJsonSerializable,AggregationVariant,ToCopyableBuilder<MultiTermsAggregation.Builder,MultiTermsAggregation>
@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class MultiTermsAggregation
extends BucketAggregationBase
implements AggregationVariant, ToCopyableBuilder<MultiTermsAggregation.Builder,MultiTermsAggregation>
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase
BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<MultiTermsAggregation> Json deserializer forMultiTermsAggregation -
Method Summary
Modifier and TypeMethodDescriptionAggregationvariant kind.builder()API name:collect_modebooleaninthashCode()final IntegerThe minimum number of documents in a bucket for it to be returned.static MultiTermsAggregationfinal HistogramOrderorder()API name:orderprotected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidfinal IntegerThe minimum number of documents in a bucket on each shard for it to be returned.final IntegerThe number of candidate terms produced by each shard.final BooleanCalculates the doc count error on per term basis.final Integersize()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.Create a new builderToCopyableBuilderthat is initialised with the current state of this object.Methods inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase
setupBucketAggregationBaseDeserializerMethods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase
meta, name, serialize, setupAggregationBaseDeserializerMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.opensearch._types.aggregations.AggregationVariant
toAggregationMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forMultiTermsAggregation
-
-
Method Details
-
of
public static MultiTermsAggregation of(Function<MultiTermsAggregation.Builder, ObjectBuilder<MultiTermsAggregation>> fn) -
_aggregationKind
Aggregationvariant kind.- Specified by:
_aggregationKindin interfaceAggregationVariant
-
collectMode
API name:collect_mode -
minDocCount
The minimum number of documents in a bucket for it to be returned.API name:
min_doc_count -
order
API name:order -
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_sizewill be automatically estimated based on the number of shards and thesizeparameter.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:
serializeInternalin classAggregationBase
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<MultiTermsAggregation.Builder,MultiTermsAggregation> - Returns:
- a new builder instance.
-
builder
-
setupMultiTermsAggregationDeserializer
protected static void setupMultiTermsAggregationDeserializer(ObjectDeserializer<MultiTermsAggregation.Builder> op) -
hashCode
public int hashCode()- Overrides:
hashCodein classBucketAggregationBase
-
equals
- Overrides:
equalsin classBucketAggregationBase
-