Class GeohexGridAggregation.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<GeohexGridAggregation.Builder>
co.elastic.clients.elasticsearch._types.aggregations.GeohexGridAggregation.Builder
- All Implemented Interfaces:
WithJson<GeohexGridAggregation.Builder>
,ObjectBuilder<GeohexGridAggregation>
- Enclosing class:
- GeohexGridAggregation
public static class GeohexGridAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<GeohexGridAggregation.Builder>
implements ObjectBuilder<GeohexGridAggregation>
Builder for
GeohexGridAggregation
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionBounding box used to filter the geo-points in each bucket.Bounding box used to filter the geo-points in each bucket.build()
Builds aGeohexGridAggregation
.Required - Field containing indexed geo-point values.Integer zoom of the key used to defined cells or buckets in the results.protected GeohexGridAggregation.Builder
self()
Number of buckets returned from each shard.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
Required - Field containing indexed geo-point values. Must be explicitly mapped as ageo_point
field. If the field contains an arraygeohex_grid
aggregates all array values.API name:
field
-
precision
Integer zoom of the key used to defined cells or buckets in the results. Value should be between 0-15.API name:
precision
-
bounds
Bounding box used to filter the geo-points in each bucket.API name:
bounds
-
bounds
public final GeohexGridAggregation.Builder bounds(Function<GeoBounds.Builder, ObjectBuilder<GeoBounds>> fn) Bounding box used to filter the geo-points in each bucket.API name:
bounds
-
size
Maximum number of buckets to return.API name:
size
-
shardSize
Number of buckets returned from each shard.API name:
shard_size
-
self
- Specified by:
self
in classAggregationBase.AbstractBuilder<GeohexGridAggregation.Builder>
-
build
Builds aGeohexGridAggregation
.- Specified by:
build
in interfaceObjectBuilder<GeohexGridAggregation>
- Throws:
NullPointerException
- if some of the required fields are null.
-