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:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<GeohexGridAggregation>
Json deserializer forGeohexGridAggregation
-
Method Summary
Modifier and TypeMethodDescriptionAggregation variant kind.final GeoBounds
bounds()
Bounding box used to filter the geo-points in each bucket.final String
field()
Required - Field containing indexedgeo_point
orgeo_shape
values.static GeohexGridAggregation
final Integer
Integer zoom of the key used to defined cells or buckets in the results.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final Integer
Number of buckets returned from each shard.final Integer
size()
Maximum number of buckets to return.Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
setupBucketAggregationBaseDeserializer
Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
meta, name, serialize, setupAggregationBaseDeserializer, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant
_toAggregation
-
Field Details
-
_DESERIALIZER
Json deserializer forGeohexGridAggregation
-
-
Method Details
-
of
public static GeohexGridAggregation of(Function<GeohexGridAggregation.Builder, ObjectBuilder<GeohexGridAggregation>> fn) -
_aggregationKind
Aggregation variant kind.- Specified by:
_aggregationKind
in interfaceAggregationVariant
-
field
Required - Field containing indexedgeo_point
orgeo_shape
values. If the field contains an array,geohex_grid
aggregates all array values.API name:
field
-
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
Bounding box used to filter the geo-points in each bucket.API name:
bounds
-
size
Maximum number of buckets to return.API name:
size
-
shardSize
Number of buckets returned from each shard.API name:
shard_size
-
serializeInternal
- Overrides:
serializeInternal
in classAggregationBase
-
setupGeohexGridAggregationDeserializer
protected static void setupGeohexGridAggregationDeserializer(ObjectDeserializer<GeohexGridAggregation.Builder> op)
-