Package org.opensearch.client.opensearch._types.aggregations

Class GeoHashGridAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<GeoHashGridAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<GeoHashGridAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.GeoHashGridAggregation.Builder

All Implemented Interfaces:

CopyableBuilder<GeoHashGridAggregation.Builder,GeoHashGridAggregation>, MutableBuilder<GeoHashGridAggregation.Builder,GeoHashGridAggregation>, ObjectBuilder<GeoHashGridAggregation>

Enclosing class:

GeoHashGridAggregation

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

Builder for GeoHashGridAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final GeoHashGridAggregation.Builder	bounds(Function<GeoBounds.Builder,ObjectBuilder<GeoBounds>> fn)	API name: bounds
final GeoHashGridAggregation.Builder	bounds(GeoBounds value)	API name: bounds
GeoHashGridAggregation	build()	Builds a GeoHashGridAggregation.
GeoHashGridAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GeoHashGridAggregation.Builder	field(String value)	API name: field
final GeoHashGridAggregation.Builder	precision(Function<GeoHashPrecision.Builder,ObjectBuilder<GeoHashPrecision>> fn)	API name: precision
final GeoHashGridAggregation.Builder	precision(GeoHashPrecision value)	API name: precision
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 org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder

meta, meta, name

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public GeoHashGridAggregation.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<GeoHashGridAggregation.Builder,GeoHashGridAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected GeoHashGridAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<GeoHashGridAggregation.Builder>

bounds

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

API name: bounds

bounds

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

API name: bounds

field

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

API name: field

precision

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

API name: precision

precision

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

API name: precision

shardSize

@Nonnull
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

@Nonnull
public final GeoHashGridAggregation.Builder size(@Nullable
 Integer value)

The maximum number of geohash buckets to return.

API name: size

build

@Nonnull
public GeoHashGridAggregation build()

Builds a GeoHashGridAggregation.

Specified by:

build in interface ObjectBuilder<GeoHashGridAggregation>

Throws:

NullPointerException - if some of the required fields are null.