Class Buckets<TBucket>
java.lang.Object
co.elastic.clients.elasticsearch._types.aggregations.Buckets<TBucket>
- All Implemented Interfaces:
JsonpSerializable
,TaggedUnion<Buckets.Kind,java.lang.Object>
public class Buckets<TBucket> extends java.lang.Object implements TaggedUnion<Buckets.Kind,java.lang.Object>, JsonpSerializable
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.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Buckets.Builder<TBucket>
static class
Buckets.Kind
-
Method Summary
Modifier and Type Method Description java.lang.Object
_get()
Buckets.Kind
_kind()
Get the of the kind of variant held by this object.java.util.List<TBucket>
array()
Get thearray
variant value.static <TBucket> JsonpDeserializer<Buckets<TBucket>>
createBucketsDeserializer(JsonpDeserializer<TBucket> tBucketDeserializer)
boolean
isArray()
Is this variant instance of kindarray
?boolean
isKeyed()
Is this variant instance of kindkeyed
?java.util.Map<java.lang.String,TBucket>
keyed()
Get thekeyed
variant value.static <TBucket> Buckets<TBucket>
of(java.util.function.Function<Buckets.Builder<TBucket>,ObjectBuilder<Buckets<TBucket>>> fn)
void
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Method Details
-
_kind
Description copied from interface:TaggedUnion
Get the of the kind of variant held by this object.- Specified by:
_kind
in interfaceTaggedUnion<Buckets.Kind,java.lang.Object>
- Returns:
- the variant kind
-
_get
public final java.lang.Object _get()- Specified by:
_get
in interfaceTaggedUnion<Buckets.Kind,java.lang.Object>
-
of
public static <TBucket> Buckets<TBucket> of(java.util.function.Function<Buckets.Builder<TBucket>,ObjectBuilder<Buckets<TBucket>>> fn) -
isArray
public boolean isArray()Is this variant instance of kindarray
? -
array
Get thearray
variant value.- Throws:
java.lang.IllegalStateException
- if the current variant is not of thearray
kind.
-
isKeyed
public boolean isKeyed()Is this variant instance of kindkeyed
? -
keyed
Get thekeyed
variant value.- Throws:
java.lang.IllegalStateException
- if the current variant is not of thekeyed
kind.
-
serialize
- Specified by:
serialize
in interfaceJsonpSerializable
-
createBucketsDeserializer
public static <TBucket> JsonpDeserializer<Buckets<TBucket>> createBucketsDeserializer(JsonpDeserializer<TBucket> tBucketDeserializer)
-