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
- 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<GeoTileGridAggregation>
Json deserializer forGeoTileGridAggregation
-
Method Summary
Modifier and TypeMethodDescriptionAggregation variant kind.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 indexedgeo_point
orgeo_shape
values.static GeoTileGridAggregation
final Number
Integer zoom of the key used to define cells/buckets in the results.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final Integer
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.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
Methods inherited from interface co.elastic.clients.elasticsearch.transform.PivotGroupByVariant
_toPivotGroupBy
-
Field Details
-
_DESERIALIZER
Json deserializer forGeoTileGridAggregation
-
-
Method Details
-
of
public static GeoTileGridAggregation of(Function<GeoTileGridAggregation.Builder, ObjectBuilder<GeoTileGridAggregation>> fn) -
_aggregationKind
Aggregation variant kind.- Specified by:
_aggregationKind
in interfaceAggregationVariant
-
_pivotGroupByKind
PivotGroupBy variant kind.- Specified by:
_pivotGroupByKind
in interfacePivotGroupByVariant
-
field
Field containing indexedgeo_point
orgeo_shape
values. If the field contains an array,geotile_grid
aggregates all array values.API name:
field
-
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
Allows for more accurate counting of the top cells returned in the final result the aggregation. Defaults to returningmax(10,(size x number-of-shards))
buckets from each shard.API name:
shard_size
-
size
The maximum number of buckets to return.API name:
size
-
bounds
A bounding box to filter the geo-points or geo-shapes in each bucket.API name:
bounds
-
serializeInternal
- Overrides:
serializeInternal
in classAggregationBase
-
setupGeoTileGridAggregationDeserializer
protected static void setupGeoTileGridAggregationDeserializer(ObjectDeserializer<GeoTileGridAggregation.Builder> op)
-