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

Class GeoHashGridAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregationBase

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, AggregationVariant, ToCopyableBuilder<GeoHashGridAggregation.Builder,GeoHashGridAggregation>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class GeoHashGridAggregation
extends BucketAggregationBase
implements AggregationVariant, ToCopyableBuilder<GeoHashGridAggregation.Builder,GeoHashGridAggregation>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeoHashGridAggregation.Builder	Builder for GeoHashGridAggregation.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<GeoHashGridAggregation>	_DESERIALIZER	Json deserializer for GeoHashGridAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
final GeoBounds	bounds()	API name: bounds
static GeoHashGridAggregation.Builder	builder()
boolean	equals(Object o)
final String	field()	API name: field
int	hashCode()
static GeoHashGridAggregation	of(Function<GeoHashGridAggregation.Builder,ObjectBuilder<GeoHashGridAggregation>> fn)
final GeoHashPrecision	precision()	API name: precision
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupGeoHashGridAggregationDeserializer(ObjectDeserializer<GeoHashGridAggregation.Builder> op)
final Integer	shardSize()	Allows for more accurate counting of the top cells returned in the final result the aggregation.
final Integer	size()	The maximum number of geohash buckets to return.
GeoHashGridAggregation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

setupBucketAggregationBaseDeserializer

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase

meta, name, serialize, setupAggregationBaseDeserializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.opensearch._types.aggregations.AggregationVariant

toAggregation

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<GeoHashGridAggregation> _DESERIALIZER

Json deserializer for GeoHashGridAggregation

Method Details

of

public static GeoHashGridAggregation of(Function<GeoHashGridAggregation.Builder,ObjectBuilder<GeoHashGridAggregation>> fn)

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

bounds

@Nullable
public final GeoBounds bounds()

API name: bounds

field

@Nullable
public final String field()

API name: field

precision

@Nullable
public final GeoHashPrecision precision()

API name: precision

shardSize

@Nullable
public final Integer shardSize()

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

@Nullable
public final Integer size()

The maximum number of geohash buckets to return.

API name: size

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class AggregationBase

toBuilder

@Nonnull
public GeoHashGridAggregation.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GeoHashGridAggregation.Builder,GeoHashGridAggregation>

Returns:

a new builder instance.

builder

@Nonnull
public static GeoHashGridAggregation.Builder builder()

setupGeoHashGridAggregationDeserializer

protected static void setupGeoHashGridAggregationDeserializer(ObjectDeserializer<GeoHashGridAggregation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class BucketAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class BucketAggregationBase