Package co.elastic.clients.elasticsearch._types.aggregations

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

  • 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,​java.lang.Object>
      Returns:
      the variant kind

    • _get

      public final java.lang.Object _get()
      Specified by:
      _get in interface TaggedUnion<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 kind array?

    • array

      public java.util.List<TBucket> array()
      Get the array variant value.
      Throws:
      java.lang.IllegalStateException - if the current variant is not of the array kind.

    • isKeyed

      public boolean isKeyed()
      Is this variant instance of kind keyed?

    • keyed

      public java.util.Map<java.lang.String,​TBucket> keyed()
      Get the keyed variant value.
      Throws:
      java.lang.IllegalStateException - if the current variant is not of the keyed kind.

    • serialize

      public void serialize​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Specified by:
      serialize in interface JsonpSerializable

    • createBucketsDeserializer

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