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

Class GeoHashGridAggregation

java.lang.Object

co.elastic.clients.elasticsearch._types.aggregations.AggregationBase

co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase

co.elastic.clients.elasticsearch._types.aggregations.GeoHashGridAggregation

All Implemented Interfaces:

AggregationVariant, JsonpSerializable

@JsonpDeserializable
public class GeoHashGridAggregation
extends BucketAggregationBase
implements AggregationVariant, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<GeoHashGridAggregation>	_DESERIALIZER	Json deserializer for GeoHashGridAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
final GeoBounds	bounds()	The bounding box to filter the points in each bucket.
final String	field()	Field containing indexed geo_point or geo_shape values.
static GeoHashGridAggregation	of(Function<GeoHashGridAggregation.Builder,ObjectBuilder<GeoHashGridAggregation>> fn)
final GeoHashPrecision	precision()	The string length of the geohashes used to define cells/buckets in the results.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupGeoHashGridAggregationDeserializer(ObjectDeserializer<GeoHashGridAggregation.Builder> op)
final Integer	shardSize()	Allows for more accurate counting of the top cells returned in the final result the aggregation.
final Integer	size()	The maximum number of geohash buckets to return.
String	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<GeoHashGridAggregation> _DESERIALIZER

Json deserializer for GeoHashGridAggregation

Method Details

of

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

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

bounds

@Nullable
public final GeoBounds bounds()

The bounding box to filter the points in each bucket.

API name: bounds

field

@Nullable
public final String field()

Field containing indexed geo_point or geo_shape values. If the field contains an array, geohash_grid aggregates all array values.

API name: field

precision

@Nullable
public final GeoHashPrecision precision()

The string length of the geohashes used to define cells/buckets in the results.

API name: precision

shardSize

@Nullable
public final Integer shardSize()

Allows for more accurate counting of the top cells returned in the final result the aggregation. Defaults to returning max(10,(size x number-of-shards)) buckets from each shard.

API name: shard_size

size

@Nullable
public final Integer size()

The maximum number of geohash buckets to return.

API name: size

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupGeoHashGridAggregationDeserializer

protected static void setupGeoHashGridAggregationDeserializer(ObjectDeserializer<GeoHashGridAggregation.Builder> op)