Package co.elastic.clients.elasticsearch._types.aggregations

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
final GeohexGridAggregation.Builder	bounds(GeoBounds value)	Bounding box used to filter the geo-points in each bucket.
final GeohexGridAggregation.Builder	bounds(Function<GeoBounds.Builder,ObjectBuilder<GeoBounds>> fn)	Bounding box used to filter the geo-points in each bucket.
GeohexGridAggregation	build()	Builds a GeohexGridAggregation.
final GeohexGridAggregation.Builder	field(String value)	Required - Field containing indexed geo_point or geo_shape values.
final GeohexGridAggregation.Builder	precision(Integer value)	Integer zoom of the key used to defined cells or buckets in the results.
protected GeohexGridAggregation.Builder	self()
final GeohexGridAggregation.Builder	shardSize(Integer value)	Number of buckets returned from each shard.
final GeohexGridAggregation.Builder	size(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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

field

public final GeohexGridAggregation.Builder field(String value)

Required - Field containing indexed geo_point or geo_shape values. If the field contains an array, geohex_grid aggregates all array values.

API name: field

precision

public final GeohexGridAggregation.Builder precision(@Nullable
 Integer value)

Integer zoom of the key used to defined cells or buckets in the results. Value should be between 0-15.

API name: precision

bounds

public final GeohexGridAggregation.Builder bounds(@Nullable
 GeoBounds value)

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

public final GeohexGridAggregation.Builder size(@Nullable
 Integer value)

Maximum number of buckets to return.

API name: size

shardSize

public final GeohexGridAggregation.Builder shardSize(@Nullable
 Integer value)

Number of buckets returned from each shard.

API name: shard_size

self

protected GeohexGridAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<GeohexGridAggregation.Builder>

build

public GeohexGridAggregation build()

Builds a GeohexGridAggregation.

Specified by:

build in interface ObjectBuilder<GeohexGridAggregation>

Throws:

NullPointerException - if some of the required fields are null.