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

Class GeoTileGridAggregation

java.lang.Object

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

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

co.elastic.clients.elasticsearch._types.aggregations.GeoTileGridAggregation

All Implemented Interfaces:

AggregationVariant, PivotGroupByVariant, JsonpSerializable

@JsonpDeserializable
public class GeoTileGridAggregation
extends BucketAggregationBase
implements AggregationVariant, PivotGroupByVariant, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
PivotGroupBy.Kind	_pivotGroupByKind()	PivotGroupBy variant kind.
final GeoBounds	bounds()	A bounding box to filter the geo-points or geo-shapes in each bucket.
final String	field()	Field containing indexed geo_point or geo_shape values.
static GeoTileGridAggregation	of(Function<GeoTileGridAggregation.Builder,ObjectBuilder<GeoTileGridAggregation>> fn)
final Number	precision()	Integer zoom of the key 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	setupGeoTileGridAggregationDeserializer(ObjectDeserializer<GeoTileGridAggregation.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 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

Methods inherited from interface co.elastic.clients.elasticsearch.transform.PivotGroupByVariant

_toPivotGroupBy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<GeoTileGridAggregation> _DESERIALIZER

Json deserializer for GeoTileGridAggregation

Method Details

of

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

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

_pivotGroupByKind

public PivotGroupBy.Kind _pivotGroupByKind()

PivotGroupBy variant kind.

Specified by:

_pivotGroupByKind in interface PivotGroupByVariant

field

@Nullable
public final String field()

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

API name: field

precision

@Nullable
public final Number precision()

Integer zoom of the key used to define cells/buckets in the results. Values outside of the range [0,29] will be rejected.

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 buckets to return.

API name: size

bounds

@Nullable
public final GeoBounds bounds()

A bounding box to filter the geo-points or geo-shapes in each bucket.

API name: bounds

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

setupGeoTileGridAggregationDeserializer

protected static void setupGeoTileGridAggregationDeserializer(ObjectDeserializer<GeoTileGridAggregation.Builder> op)