Package org.opensearch.geo.search.aggregations.metrics

Class GeoBoundsAggregationBuilder

java.lang.Object

org.opensearch.search.aggregations.AggregationBuilder

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

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

org.opensearch.geo.search.aggregations.metrics.GeoBoundsAggregationBuilder

All Implemented Interfaces:

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

public class GeoBoundsAggregationBuilder
extends ValuesSourceAggregationBuilder<GeoBoundsAggregationBuilder>

Aggregation Builder for geo_bounds agg

Opensearch.internal:

Nested Class Summary

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 String	NAME
static final ObjectParser<GeoBoundsAggregationBuilder,String>	PARSER
static final ValuesSourceRegistry.RegistryKey<GeoBoundsAggregatorSupplier>	REGISTRY_KEY

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

Modifier	Constructor	Description
	GeoBoundsAggregationBuilder(String name)
	GeoBoundsAggregationBuilder(StreamInput in)	Read from a stream.
protected	GeoBoundsAggregationBuilder(GeoBoundsAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
AggregationBuilder.BucketCardinality	bucketCardinality()
protected ValuesSourceType	defaultValueSourceType()
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object obj)
protected ValuesSourceRegistry.RegistryKey<?>	getRegistryKey()
String	getType()
int	hashCode()
protected org.opensearch.geo.search.aggregations.metrics.GeoBoundsAggregatorFactory	innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void	innerWriteTo(StreamOutput out)
static void	registerAggregators(ValuesSourceRegistry.Builder builder)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)
GeoBoundsAggregationBuilder	wrapLongitude(boolean wrapLongitude)	Set whether to wrap longitudes.

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

REGISTRY_KEY

public static final ValuesSourceRegistry.RegistryKey<GeoBoundsAggregatorSupplier> REGISTRY_KEY

PARSER

public static final ObjectParser<GeoBoundsAggregationBuilder,String> PARSER

Constructor Details

GeoBoundsAggregationBuilder

public GeoBoundsAggregationBuilder(String name)

GeoBoundsAggregationBuilder

protected GeoBoundsAggregationBuilder(GeoBoundsAggregationBuilder clone,
 AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

GeoBoundsAggregationBuilder

public GeoBoundsAggregationBuilder(StreamInput in)
                            throws IOException

Read from a stream.

Throws:

IOException

Method Details

registerAggregators

public static void registerAggregators(ValuesSourceRegistry.Builder builder)

shallowCopy

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

Specified by:

shallowCopy in class AggregationBuilder

innerWriteTo

protected void innerWriteTo(StreamOutput out)
                     throws IOException

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<GeoBoundsAggregationBuilder>

Throws:

IOException

defaultValueSourceType

protected ValuesSourceType defaultValueSourceType()

Specified by:

defaultValueSourceType in class ValuesSourceAggregationBuilder<GeoBoundsAggregationBuilder>

wrapLongitude

public GeoBoundsAggregationBuilder wrapLongitude(boolean wrapLongitude)

Set whether to wrap longitudes. Defaults to true.

bucketCardinality

public AggregationBuilder.BucketCardinality bucketCardinality()

Specified by:

bucketCardinality in class AggregationBuilder

innerBuild

protected org.opensearch.geo.search.aggregations.metrics.GeoBoundsAggregatorFactory innerBuild(QueryShardContext queryShardContext,
 ValuesSourceConfig config,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                                                                                        throws IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<GeoBoundsAggregationBuilder>

Throws:

IOException

doXContentBody

public XContentBuilder doXContentBody(XContentBuilder builder,
 ToXContent.Params params)
                               throws IOException

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<GeoBoundsAggregationBuilder>

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class ValuesSourceAggregationBuilder<GeoBoundsAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class ValuesSourceAggregationBuilder<GeoBoundsAggregationBuilder>

getType

public String getType()

getRegistryKey

protected ValuesSourceRegistry.RegistryKey<?> getRegistryKey()

Specified by:

getRegistryKey in class ValuesSourceAggregationBuilder<GeoBoundsAggregationBuilder>