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

Class MultiBucketBase

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.MultiBucketBase

All Implemented Interfaces:

JsonpSerializable

Direct Known Subclasses:

AdjacencyMatrixBucket, CompositeBucket, DateHistogramBucket, FiltersBucket, GeoHashGridBucket, GeoTileGridBucket, HistogramBucket, IpRangeBucket, LongRareTermsBucket, MultiTermsBucket, RangeBucket, SignificantTermsBucketBase, StringRareTermsBucket, TermsBucketBase, TopMetricsBucket, VariableWidthHistogramBucket

public abstract class MultiBucketBase
extends java.lang.Object
implements JsonpSerializable

Base type for multi-bucket aggregation results that can hold sub-aggregations results.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	MultiBucketBase.AbstractBuilder<BuilderT extends MultiBucketBase.AbstractBuilder<BuilderT>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MultiBucketBase(MultiBucketBase.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,Aggregate>	aggregations()	Nested aggregations
long	docCount()	Required - API name: doc_count
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <BuilderT extends MultiBucketBase.AbstractBuilder<BuilderT>> void	setupMultiBucketBaseDeserializer(ObjectDeserializer<BuilderT> op)

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiBucketBase

protected MultiBucketBase(MultiBucketBase.AbstractBuilder<?> builder)

Method Detail

aggregations

public final java.util.Map<java.lang.String,Aggregate> aggregations()

Nested aggregations

docCount

public final long docCount()

Required - API name: doc_count

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

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

setupMultiBucketBaseDeserializer

protected static <BuilderT extends MultiBucketBase.AbstractBuilder<BuilderT>> void setupMultiBucketBaseDeserializer(ObjectDeserializer<BuilderT> op)