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
- 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<GeoHashGridAggregation>
Json deserializer forGeoHashGridAggregation
-
Method Summary
Modifier and TypeMethodDescriptionAggregation variant kind.final GeoBounds
bounds()
The bounding box to filter the points in each bucket.final String
field()
Field containing indexedgeo_point
orgeo_shape
values.static GeoHashGridAggregation
final GeoHashPrecision
The string length of the geohashes 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 geohash 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 forGeoHashGridAggregation
-
-
Method Details
-
of
public static GeoHashGridAggregation of(Function<GeoHashGridAggregation.Builder, ObjectBuilder<GeoHashGridAggregation>> fn) -
_aggregationKind
Aggregation variant kind.- Specified by:
_aggregationKind
in interfaceAggregationVariant
-
bounds
The bounding box to filter the points in each bucket.API name:
bounds
-
field
Field containing indexedgeo_point
orgeo_shape
values. If the field contains an array,geohash_grid
aggregates all array values.API name:
field
-
precision
The string length of the geohashes used to define cells/buckets in the results.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 geohash buckets to return.API name:
size
-
serializeInternal
- Overrides:
serializeInternal
in classAggregationBase
-
setupGeoHashGridAggregationDeserializer
protected static void setupGeoHashGridAggregationDeserializer(ObjectDeserializer<GeoHashGridAggregation.Builder> op)
-