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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeohexGridAggregation.Builder	Builder for GeohexGridAggregation.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase

BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<GeohexGridAggregation>	_DESERIALIZER	Json deserializer for GeohexGridAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
final GeoBounds	bounds()	Bounding box used to filter the geo-points in each bucket.
final String	field()	Required - Field containing indexed geo-point values.
static GeohexGridAggregation	of(Function<GeohexGridAggregation.Builder,ObjectBuilder<GeohexGridAggregation>> fn)
final Integer	precision()	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	setupGeohexGridAggregationDeserializer(ObjectDeserializer<GeohexGridAggregation.Builder> op)
final Integer	shardSize()	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

public static final JsonpDeserializer<GeohexGridAggregation> _DESERIALIZER

Json deserializer for GeohexGridAggregation

Method Details

of

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

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

field

public final 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 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 Integer size()

Maximum number of buckets to return.

API name: size

shardSize

@Nullable
public final 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)