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

Class GeoTileGridAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

org.opensearch.client.opensearch._types.aggregations.GeoTileGridAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

GeoTileGridAggregation

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

Builder for GeoTileGridAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Returns:

a new builder instance.

self

@Nonnull
protected GeoTileGridAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<GeoTileGridAggregation.Builder>

bounds

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

API name: bounds

bounds

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

API name: bounds

field

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

API name: field

precision

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

API name: precision

shardSize

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

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

The maximum number of buckets to return.

API name: size

build

@Nonnull
public GeoTileGridAggregation build()

Builds a GeoTileGridAggregation.

Specified by:

build in interface ObjectBuilder<GeoTileGridAggregation>

Throws:

NullPointerException - if some of the required fields are null.