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

Class GeoHashGridAggregation.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<GeoHashGridAggregation.Builder>

co.elastic.clients.elasticsearch._types.aggregations.GeoHashGridAggregation.Builder

All Implemented Interfaces:

WithJson<GeoHashGridAggregation.Builder>, ObjectBuilder<GeoHashGridAggregation>

Enclosing class:

GeoHashGridAggregation

public static class GeoHashGridAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<GeoHashGridAggregation.Builder>
implements ObjectBuilder<GeoHashGridAggregation>

Builder for GeoHashGridAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final GeoHashGridAggregation.Builder	bounds(GeoBounds value)	The bounding box to filter the points in each bucket.
final GeoHashGridAggregation.Builder	bounds(Function<GeoBounds.Builder,ObjectBuilder<GeoBounds>> fn)	The bounding box to filter the points in each bucket.
GeoHashGridAggregation	build()	Builds a GeoHashGridAggregation.
final GeoHashGridAggregation.Builder	field(String value)	Field containing indexed geo_point or geo_shape values.
final GeoHashGridAggregation.Builder	precision(GeoHashPrecision value)	The string length of the geohashes used to define cells/buckets in the results.
final GeoHashGridAggregation.Builder	precision(Function<GeoHashPrecision.Builder,ObjectBuilder<GeoHashPrecision>> fn)	The string length of the geohashes used to define cells/buckets in the results.
protected GeoHashGridAggregation.Builder	self()
final GeoHashGridAggregation.Builder	shardSize(Integer value)	Allows for more accurate counting of the top cells returned in the final result the aggregation.
final GeoHashGridAggregation.Builder	size(Integer value)	The maximum number of geohash buckets to return.

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

bounds

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

The bounding box to filter the points in each bucket.

API name: bounds

bounds

public final GeoHashGridAggregation.Builder bounds(Function<GeoBounds.Builder,ObjectBuilder<GeoBounds>> fn)

The bounding box to filter the points in each bucket.

API name: bounds

field

public final GeoHashGridAggregation.Builder field(@Nullable
 String value)

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

API name: field

precision

public final GeoHashGridAggregation.Builder precision(@Nullable
 GeoHashPrecision value)

The string length of the geohashes used to define cells/buckets in the results.

API name: precision

precision

public final GeoHashGridAggregation.Builder precision(Function<GeoHashPrecision.Builder,ObjectBuilder<GeoHashPrecision>> fn)

The string length of the geohashes used to define cells/buckets in the results.

API name: precision

shardSize

public final GeoHashGridAggregation.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 GeoHashGridAggregation.Builder size(@Nullable
 Integer value)

The maximum number of geohash buckets to return.

API name: size

self

protected GeoHashGridAggregation.Builder self()

Specified by:

self in class BucketAggregationBase.AbstractBuilder<GeoHashGridAggregation.Builder>

build

public GeoHashGridAggregation build()

Builds a GeoHashGridAggregation.

Specified by:

build in interface ObjectBuilder<GeoHashGridAggregation>

Throws:

NullPointerException - if some of the required fields are null.