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<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.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

bounds

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

API name: bounds

bounds

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

API name: bounds

field

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

API name: field

precision

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

API name: precision

precision

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

API name: precision

shardSize

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

API name: shard_size

size

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

API name: size

self

protected GeoHashGridAggregation.Builder self()

Specified by:

self in class AggregationBase.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.