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

Class GeoHashGridAggregation.Builder

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.Aggregation.AbstractBuilder<BuilderT>

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

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

All Implemented Interfaces:

ObjectBuilder<GeoHashGridAggregation>

Enclosing class:

GeoHashGridAggregation

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

Builder for GeoHashGridAggregation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GeoHashGridAggregation.Builder	bounds(java.util.function.Function<BoundingBox.Builder,ObjectBuilder<BoundingBox>> fn)	API name: bounds
GeoHashGridAggregation.Builder	bounds(BoundingBox value)	API name: bounds
GeoHashGridAggregation	build()	Builds a GeoHashGridAggregation.
GeoHashGridAggregation.Builder	field(java.lang.String value)	API name: field
GeoHashGridAggregation.Builder	precision(java.lang.Number value)	API name: precision
protected GeoHashGridAggregation.Builder	self()
GeoHashGridAggregation.Builder	shardSize(java.lang.Number value)	API name: shard_size
GeoHashGridAggregation.Builder	size(java.lang.Number value)	API name: size

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder

aggregations, aggregations, putAggregations, putAggregations

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.Aggregation.AbstractBuilder

meta, name, putMeta

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

bounds

public GeoHashGridAggregation.Builder bounds(@Nullable BoundingBox value)

API name: bounds

bounds

public GeoHashGridAggregation.Builder bounds(java.util.function.Function<BoundingBox.Builder,ObjectBuilder<BoundingBox>> fn)

API name: bounds

field

public GeoHashGridAggregation.Builder field(@Nullable java.lang.String value)

API name: field

precision

public GeoHashGridAggregation.Builder precision(@Nullable java.lang.Number value)

API name: precision

shardSize

public GeoHashGridAggregation.Builder shardSize(@Nullable java.lang.Number value)

API name: shard_size

size

public GeoHashGridAggregation.Builder size(@Nullable java.lang.Number value)

API name: size

self

protected GeoHashGridAggregation.Builder self()

Specified by:

self in class Aggregation.AbstractBuilder<GeoHashGridAggregation.Builder>

build

public GeoHashGridAggregation build()

Builds a GeoHashGridAggregation.

Specified by:

build in interface ObjectBuilder<GeoHashGridAggregation>

Throws:

java.lang.NullPointerException - if some of the required fields are null.