Class GeoTileGridAggregation.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>
co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase.AbstractBuilder<GeoTileGridAggregation.Builder>
co.elastic.clients.elasticsearch._types.aggregations.GeoTileGridAggregation.Builder
- All Implemented Interfaces:
WithJson<GeoTileGridAggregation.Builder>
,ObjectBuilder<GeoTileGridAggregation>
- Enclosing class:
- GeoTileGridAggregation
public static class GeoTileGridAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<GeoTileGridAggregation.Builder>
implements ObjectBuilder<GeoTileGridAggregation>
Builder for
GeoTileGridAggregation
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionA bounding box to filter the geo-points or geo-shapes in each bucket.A bounding box to filter the geo-points or geo-shapes in each bucket.build()
Builds aGeoTileGridAggregation
.Field containing indexedgeo_point
orgeo_shape
values.Integer zoom of the key used to define cells/buckets in the results.protected GeoTileGridAggregation.Builder
self()
Allows for more accurate counting of the top cells returned in the final result the aggregation.The maximum number of buckets to return.Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder
meta, meta, name
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
-
bounds
public final GeoTileGridAggregation.Builder bounds(Function<GeoBounds.Builder, ObjectBuilder<GeoBounds>> fn) A bounding box to filter the geo-points or geo-shapes in each bucket.API name:
bounds
-
self
- Specified by:
self
in classAggregationBase.AbstractBuilder<GeoTileGridAggregation.Builder>
-
build
Builds aGeoTileGridAggregation
.- Specified by:
build
in interfaceObjectBuilder<GeoTileGridAggregation>
- Throws:
NullPointerException
- if some of the required fields are null.
-