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

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final GeoTileGridAggregation.Builder	bounds(GeoBounds value)	A bounding box to filter the geo-points or geo-shapes in each bucket.
final GeoTileGridAggregation.Builder	bounds(Function<GeoBounds.Builder,ObjectBuilder<GeoBounds>> fn)	A bounding box to filter the geo-points or geo-shapes in each bucket.
GeoTileGridAggregation	build()	Builds a GeoTileGridAggregation.
final GeoTileGridAggregation.Builder	field(String value)	Field containing indexed geo_point or geo_shape values.
final GeoTileGridAggregation.Builder	precision(Number value)	Integer zoom of the key used to define cells/buckets in the results.
protected GeoTileGridAggregation.Builder	self()
final GeoTileGridAggregation.Builder	shardSize(Integer value)	Allows for more accurate counting of the top cells returned in the final result the aggregation.
final GeoTileGridAggregation.Builder	size(Integer value)	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

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 GeoTileGridAggregation.Builder field(@Nullable
 String value)

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

API name: field

precision

public final GeoTileGridAggregation.Builder precision(@Nullable
 Number value)

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

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

Allows for more accurate counting of the top cells returned in the final result the aggregation. Defaults to returning max(10,(size x number-of-shards)) buckets from each shard.

API name: shard_size

size

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

The maximum number of buckets to return.

API name: size

bounds

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

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

protected GeoTileGridAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<GeoTileGridAggregation.Builder>

build

public GeoTileGridAggregation build()

Builds a GeoTileGridAggregation.

Specified by:

build in interface ObjectBuilder<GeoTileGridAggregation>

Throws:

NullPointerException - if some of the required fields are null.