Class GeoTileGridAggregationBuilder
java.lang.Object
org.opensearch.search.aggregations.AggregationBuilder
org.opensearch.search.aggregations.AbstractAggregationBuilder<AB>
org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder<GeoGridAggregationBuilder>
org.opensearch.search.aggregations.bucket.geogrid.GeoGridAggregationBuilder
org.opensearch.search.aggregations.bucket.geogrid.GeoTileGridAggregationBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,org.opensearch.common.xcontent.ToXContent
,org.opensearch.common.xcontent.ToXContentFragment
,Rewriteable<AggregationBuilder>
,BaseAggregationBuilder
public class GeoTileGridAggregationBuilder extends GeoGridAggregationBuilder
-
Nested Class Summary
Nested classes/interfaces inherited from class org.opensearch.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
org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_PRECISION
static java.lang.String
NAME
static org.opensearch.common.xcontent.ObjectParser<GeoTileGridAggregationBuilder,java.lang.String>
PARSER
static ValuesSourceRegistry.RegistryKey<GeoGridAggregatorSupplier>
REGISTRY_KEY
Fields inherited from class org.opensearch.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.AggregationBuilder
factoriesBuilder, name
-
Constructor Summary
Constructors Constructor Description GeoTileGridAggregationBuilder(java.lang.String name)
GeoTileGridAggregationBuilder(StreamInput in)
-
Method Summary
Modifier and Type Method Description protected ValuesSourceAggregatorFactory
createFactory(java.lang.String name, ValuesSourceConfig config, int precision, int requiredSize, int shardSize, GeoBoundingBox geoBoundingBox, QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)
Creates a new instance of theValuesSourceAggregatorFactory
-derived class specific to the geo aggregation.protected ValuesSourceRegistry.RegistryKey<?>
getRegistryKey()
java.lang.String
getType()
The name of the type of aggregation built by this builder.GeoGridAggregationBuilder
precision(int precision)
method to validate and set the precision valuestatic void
registerAggregators(ValuesSourceRegistry.Builder builder)
protected AggregationBuilder
shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)
Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilder
andmetadata
.Methods inherited from class org.opensearch.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
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
DEFAULT_PRECISION
public static final int DEFAULT_PRECISION- See Also:
- Constant Field Values
-
REGISTRY_KEY
-
PARSER
public static final org.opensearch.common.xcontent.ObjectParser<GeoTileGridAggregationBuilder,java.lang.String> PARSER
-
-
Constructor Details
-
GeoTileGridAggregationBuilder
public GeoTileGridAggregationBuilder(java.lang.String name) -
GeoTileGridAggregationBuilder
- Throws:
java.io.IOException
-
-
Method Details
-
registerAggregators
-
precision
Description copied from class:GeoGridAggregationBuilder
method to validate and set the precision value- Specified by:
precision
in classGeoGridAggregationBuilder
- Parameters:
precision
- the precision to set for the aggregation- Returns:
- the
GeoGridAggregationBuilder
builder
-
createFactory
protected ValuesSourceAggregatorFactory createFactory(java.lang.String name, ValuesSourceConfig config, int precision, int requiredSize, int shardSize, GeoBoundingBox geoBoundingBox, QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata) throws java.io.IOExceptionDescription copied from class:GeoGridAggregationBuilder
Creates a new instance of theValuesSourceAggregatorFactory
-derived class specific to the geo aggregation.- Specified by:
createFactory
in classGeoGridAggregationBuilder
- Throws:
java.io.IOException
-
shallowCopy
protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)Description copied from class:AggregationBuilder
Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilder
andmetadata
. Used byAggregationBuilder.rewrite(QueryRewriteContext)
.- Specified by:
shallowCopy
in classAggregationBuilder
-
getType
public java.lang.String getType()Description copied from interface:BaseAggregationBuilder
The name of the type of aggregation built by this builder. -
getRegistryKey
- Specified by:
getRegistryKey
in classValuesSourceAggregationBuilder<GeoGridAggregationBuilder>
-