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
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description GeohexGridAggregation.Builder
bounds(GeoBounds value)
Bounding box used to filter the geo-points in each bucket.GeohexGridAggregation.Builder
bounds(java.util.function.Function<GeoBounds.Builder,ObjectBuilder<GeoBounds>> fn)
Bounding box used to filter the geo-points in each bucket.GeohexGridAggregation
build()
Builds aGeohexGridAggregation
.GeohexGridAggregation.Builder
field(java.lang.String value)
Required - Field containing indexed geo-point values.GeohexGridAggregation.Builder
precision(java.lang.Integer value)
Integer zoom of the key used to defined cells or buckets in the results.protected GeohexGridAggregation.Builder
self()
GeohexGridAggregation.Builder
shardSize(java.lang.Integer value)
Number of buckets returned from each shard.GeohexGridAggregation.Builder
size(java.lang.Integer value)
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
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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(java.util.function.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:
java.lang.NullPointerException
- if some of the required fields are null.
-