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

Class GeohexGridAggregation

java.lang.Object
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
co.elastic.clients.elasticsearch._types.aggregations.GeohexGridAggregation
All Implemented Interfaces:
AggregationVariant, JsonpSerializable
@JsonpDeserializable
public class GeohexGridAggregation
extends BucketAggregationBase
implements AggregationVariant
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static GeohexGridAggregation of​(java.util.function.Function<GeohexGridAggregation.Builder,​ObjectBuilder<GeohexGridAggregation>> fn)

    • _aggregationKind

      public Aggregation.Kind _aggregationKind()
      Aggregation variant kind.
      Specified by:
      _aggregationKind in interface AggregationVariant

    • field

      public final java.lang.String field()
      Required - Field containing indexed geo-point values. Must be explicitly mapped as a geo_point field. If the field contains an array geohex_grid aggregates all array values.

      API name: field

    • precision

      @Nullable public final java.lang.Integer precision()
      Integer zoom of the key used to defined cells or buckets in the results. Value should be between 0-15.

      API name: precision

    • bounds

      @Nullable public final GeoBounds bounds()
      Bounding box used to filter the geo-points in each bucket.

      API name: bounds

    • size

      @Nullable public final java.lang.Integer size()
      Maximum number of buckets to return.

      API name: size

    • shardSize

      @Nullable public final java.lang.Integer shardSize()
      Number of buckets returned from each shard.

      API name: shard_size

    • serializeInternal

      protected void serializeInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Overrides:
      serializeInternal in class AggregationBase

    • setupGeohexGridAggregationDeserializer

      protected static void setupGeohexGridAggregationDeserializer​(ObjectDeserializer<GeohexGridAggregation.Builder> op)