Package org.opensearch.client.opensearch._types.aggregations

Class TermsAggregateBase<TBucket>

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregateBase

org.opensearch.client.opensearch._types.aggregations.MultiBucketAggregateBase<TBucket>

org.opensearch.client.opensearch._types.aggregations.TermsAggregateBase<TBucket>

All Implemented Interfaces:

JsonpSerializable

Direct Known Subclasses:

DoubleTermsAggregate, LongTermsAggregate, MultiTermsAggregate, StringTermsAggregate, UnmappedTermsAggregate

public abstract class TermsAggregateBase<TBucket>
extends MultiBucketAggregateBase<TBucket>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	TermsAggregateBase.AbstractBuilder<TBucket,BuilderT extends TermsAggregateBase.AbstractBuilder<TBucket,BuilderT>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TermsAggregateBase(TermsAggregateBase.AbstractBuilder<TBucket,?> builder)

Method Summary

Modifier and Type	Method	Description
java.lang.Long	docCountErrorUpperBound()	API name: doc_count_error_upper_bound
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <TBucket,BuilderT extends TermsAggregateBase.AbstractBuilder<TBucket,BuilderT>> void	setupTermsAggregateBaseDeserializer(ObjectDeserializer<BuilderT> op, JsonpDeserializer<TBucket> tBucketDeserializer)
long	sumOtherDocCount()	Required - API name: sum_other_doc_count

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.MultiBucketAggregateBase

buckets, setupMultiBucketAggregateBaseDeserializer

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregateBase

meta, serialize, setupAggregateBaseDeserializer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TermsAggregateBase

protected TermsAggregateBase(TermsAggregateBase.AbstractBuilder<TBucket,?> builder)

Method Detail

docCountErrorUpperBound

@Nullable
public final java.lang.Long docCountErrorUpperBound()

API name: doc_count_error_upper_bound

sumOtherDocCount

public final long sumOtherDocCount()

Required - API name: sum_other_doc_count

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

Overrides:

serializeInternal in class MultiBucketAggregateBase<TBucket>

setupTermsAggregateBaseDeserializer

protected static <TBucket,BuilderT extends TermsAggregateBase.AbstractBuilder<TBucket,BuilderT>> void setupTermsAggregateBaseDeserializer(ObjectDeserializer<BuilderT> op,
                                                                                                                                                      JsonpDeserializer<TBucket> tBucketDeserializer)