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

Class Buckets<TBucket>

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, TaggedUnion<Buckets.Kind,Object>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public class Buckets<TBucket>
extends Object
implements TaggedUnion<Buckets.Kind,Object>, PlainJsonSerializable

Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Buckets.Builder<TBucket>
static enum	Buckets.Kind	Buckets variant kinds.

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final Buckets.Kind	_kind()	Get the of the kind of variant held by this object.
List<TBucket>	array()	Get the array variant value.
static <TBucket> Buckets.Builder	builder()
static <TBucket> JsonpDeserializer<Buckets<TBucket>>	createBucketsDeserializer(JsonpDeserializer<TBucket> tBucketDeserializer)
boolean	equals(Object o)
int	hashCode()
boolean	isArray()	Is this variant instance of kind array?
boolean	isKeyed()	Is this variant instance of kind keyed?
Map<String,TBucket>	keyed()	Get the keyed variant value.
static <TBucket> Buckets<TBucket>	of(Function<Buckets.Builder<TBucket>,ObjectBuilder<Buckets<TBucket>>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
final JsonpSerializer<TBucket>	tBucketSerializer()	Serializer for TBucket.
Buckets.Builder<TBucket>	toBuilder()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Method Details

_kind

public final Buckets.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<Buckets.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<Buckets.Kind,Object>

of

public static <TBucket> Buckets<TBucket> of(Function<Buckets.Builder<TBucket>,ObjectBuilder<Buckets<TBucket>>> fn)

tBucketSerializer

@Nullable
public final JsonpSerializer<TBucket> tBucketSerializer()

Serializer for TBucket. If not set, an attempt will be made to find a serializer from the JSON context.

isArray

public boolean isArray()

Is this variant instance of kind array?

array

public List<TBucket> array()

Get the array variant value.

Throws:

IllegalStateException - if the current variant is not the array kind.

isKeyed

public boolean isKeyed()

Is this variant instance of kind keyed?

keyed

public Map<String,TBucket> keyed()

Get the keyed variant value.

Throws:

IllegalStateException - if the current variant is not the keyed kind.

serialize

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

Specified by:

serialize in interface JsonpSerializable

toBuilder

@Nonnull
public Buckets.Builder<TBucket> toBuilder()

builder

@Nonnull
public static <TBucket> Buckets.Builder builder()

createBucketsDeserializer

public static <TBucket>
JsonpDeserializer<Buckets<TBucket>> createBucketsDeserializer(JsonpDeserializer<TBucket> tBucketDeserializer)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object