Package org.opensearch.geo.search.aggregations.bucket.geogrid

Class GeoHashGridAggregationBuilder

java.lang.Object

org.opensearch.search.aggregations.AggregationBuilder

org.opensearch.search.aggregations.AbstractAggregationBuilder<AB>

org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder<GeoGridAggregationBuilder>

org.opensearch.geo.search.aggregations.bucket.geogrid.GeoGridAggregationBuilder

org.opensearch.geo.search.aggregations.bucket.geogrid.GeoHashGridAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, Rewriteable<AggregationBuilder>, BaseAggregationBuilder

public class GeoHashGridAggregationBuilder
extends GeoGridAggregationBuilder

Aggregation Builder for geohash_grid

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.geo.search.aggregations.bucket.geogrid.GeoGridAggregationBuilder

GeoGridAggregationBuilder.PrecisionParser

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder

ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<AB>>

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.AggregationBuilder

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_NUM_CELLS
static final int	DEFAULT_PRECISION
static final String	NAME
static final ObjectParser<GeoHashGridAggregationBuilder,String>	PARSER
static final ValuesSourceRegistry.RegistryKey<GeoGridAggregatorSupplier>	REGISTRY_KEY

Fields inherited from class org.opensearch.geo.search.aggregations.bucket.geogrid.GeoGridAggregationBuilder

precision, requiredSize, shardSize

Fields inherited from class org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder

config

Fields inherited from class org.opensearch.search.aggregations.AbstractAggregationBuilder

metadata

Fields inherited from class org.opensearch.search.aggregations.AggregationBuilder

factoriesBuilder, name

Fields inherited from interface org.opensearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
GeoHashGridAggregationBuilder(String name)
GeoHashGridAggregationBuilder(StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected ValuesSourceAggregatorFactory	createFactory(String name, ValuesSourceConfig config, int precision, int requiredSize, int shardSize, GeoBoundingBox geoBoundingBox, QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder, Map<String,Object> metadata)	Creates a new instance of the ValuesSourceAggregatorFactory-derived class specific to the geo aggregation.
protected ValuesSourceRegistry.RegistryKey<?>	getRegistryKey()
String	getType()
GeoGridAggregationBuilder	precision(int precision)	method to validate and set the precision value
static void	registerAggregators(ValuesSourceRegistry.Builder builder)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Methods inherited from class org.opensearch.geo.search.aggregations.bucket.geogrid.GeoGridAggregationBuilder

bucketCardinality, createParser, defaultValueSourceType, doXContentBody, equals, geoBoundingBox, hashCode, innerBuild, innerWriteTo, precision, setGeoBoundingBox, shardSize, shardSize, size, size

Methods inherited from class org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder

declareFields, declareFields, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, serializeTargetValueType, timeZone, timeZone, userValueTypeHint, userValueTypeHint

Methods inherited from class org.opensearch.search.aggregations.AbstractAggregationBuilder

build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeTo

Methods inherited from class org.opensearch.search.aggregations.AggregationBuilder

buildPipelineTree, doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

DEFAULT_PRECISION

public static final int DEFAULT_PRECISION

See Also:

• Constant Field Values

DEFAULT_MAX_NUM_CELLS

public static final int DEFAULT_MAX_NUM_CELLS

See Also:

• Constant Field Values

REGISTRY_KEY

public static final ValuesSourceRegistry.RegistryKey<GeoGridAggregatorSupplier> REGISTRY_KEY

PARSER

public static final ObjectParser<GeoHashGridAggregationBuilder,String> PARSER

Constructor Details

GeoHashGridAggregationBuilder

public GeoHashGridAggregationBuilder(String name)

GeoHashGridAggregationBuilder

public GeoHashGridAggregationBuilder(StreamInput in)
                              throws IOException

Throws:

IOException

Method Details

registerAggregators

public static void registerAggregators(ValuesSourceRegistry.Builder builder)

precision

public GeoGridAggregationBuilder precision(int precision)

Description copied from class: GeoGridAggregationBuilder

method to validate and set the precision value

Specified by:

precision in class GeoGridAggregationBuilder

Parameters:

precision - the precision to set for the aggregation

Returns:

the GeoGridAggregationBuilder builder

createFactory

protected ValuesSourceAggregatorFactory createFactory(String name,
 ValuesSourceConfig config,
 int precision,
 int requiredSize,
 int shardSize,
 GeoBoundingBox geoBoundingBox,
 QueryShardContext queryShardContext,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder,
 Map<String,Object> metadata)
                                               throws IOException

Description copied from class: GeoGridAggregationBuilder

Creates a new instance of the ValuesSourceAggregatorFactory-derived class specific to the geo aggregation.

Specified by:

createFactory in class GeoGridAggregationBuilder

Throws:

IOException

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

Specified by:

shallowCopy in class AggregationBuilder

getType

public String getType()

getRegistryKey

protected ValuesSourceRegistry.RegistryKey<?> getRegistryKey()

Specified by:

getRegistryKey in class ValuesSourceAggregationBuilder<GeoGridAggregationBuilder>