Package org.opensearch.search.aggregations.bucket.range

Class GeoDistanceAggregationBuilder

java.lang.Object

org.opensearch.search.aggregations.AggregationBuilder

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

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

org.opensearch.search.aggregations.bucket.range.GeoDistanceAggregationBuilder

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, Rewriteable<AggregationBuilder>, BaseAggregationBuilder

public class GeoDistanceAggregationBuilder
extends ValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>

Aggregation Builder for geo_distance agg

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeoDistanceAggregationBuilder.Range	Range for a geo distance agg

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.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final ValuesSourceRegistry.RegistryKey<GeoDistanceAggregatorSupplier>	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.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	GeoDistanceAggregationBuilder(String name, GeoPoint origin)
	GeoDistanceAggregationBuilder(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.
protected	GeoDistanceAggregationBuilder(GeoDistanceAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
GeoDistanceAggregationBuilder	addRange(double from, double to)	Same as addRange(String, double, double) but the key will be automatically generated based on from and to.
GeoDistanceAggregationBuilder	addRange(String key, double from, double to)	Add a new range to this aggregation.
GeoDistanceAggregationBuilder	addRange(GeoDistanceAggregationBuilder.Range range)
GeoDistanceAggregationBuilder	addUnboundedFrom(double from)	Same as addUnboundedFrom(String, double) but the key will be computed automatically.
GeoDistanceAggregationBuilder	addUnboundedFrom(String key, double from)	Add a new range with no upper bound.
GeoDistanceAggregationBuilder	addUnboundedTo(double to)	Same as addUnboundedTo(String, double) but the key will be computed automatically.
GeoDistanceAggregationBuilder	addUnboundedTo(String key, double to)	Add a new range with no lower bound.
AggregationBuilder.BucketCardinality	bucketCardinality()	A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.
protected ValuesSourceType	defaultValueSourceType()	Aggregations should use this method to define a ValuesSourceType of last resort.
GeoDistance	distanceType()
GeoDistanceAggregationBuilder	distanceType(GeoDistance distanceType)
protected org.opensearch.core.xcontent.XContentBuilder	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
protected ValuesSourceRegistry.RegistryKey<?>	getRegistryKey()
String	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
protected ValuesSourceAggregatorFactory	innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void	innerWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)	Write subclass's state to the stream.
boolean	keyed()
GeoDistanceAggregationBuilder	keyed(boolean keyed)
GeoPoint	origin()	Return the GeoPoint that is used for distance computations.
static AggregationBuilder	parse(String aggregationName, org.opensearch.core.xcontent.XContentParser parser)
List<GeoDistanceAggregationBuilder.Range>	range()
static void	registerAggregators(ValuesSourceRegistry.Builder builder)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.
DistanceUnit	unit()
GeoDistanceAggregationBuilder	unit(DistanceUnit unit)

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.core.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

REGISTRY_KEY

public static final ValuesSourceRegistry.RegistryKey<GeoDistanceAggregatorSupplier> REGISTRY_KEY

Constructor Details

GeoDistanceAggregationBuilder

public GeoDistanceAggregationBuilder(String name,
 GeoPoint origin)

GeoDistanceAggregationBuilder

public GeoDistanceAggregationBuilder(org.opensearch.core.common.io.stream.StreamInput in)
                              throws IOException

Read from a stream.

Throws:

IOException

GeoDistanceAggregationBuilder

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

Method Details

parse

public static AggregationBuilder parse(String aggregationName,
 org.opensearch.core.xcontent.XContentParser parser)
                                throws IOException

Throws:

IOException

registerAggregators

public static void registerAggregators(ValuesSourceRegistry.Builder builder)

defaultValueSourceType

protected ValuesSourceType defaultValueSourceType()

Description copied from class: ValuesSourceAggregationBuilder

Aggregations should use this method to define a ValuesSourceType of last resort. This will only be used when the resolver can't find a field and the user hasn't provided a value type hint.

Specified by:

defaultValueSourceType in class ValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>

Returns:

The CoreValuesSourceType we expect this script to yield.

shallowCopy

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

Description copied from class: AggregationBuilder

Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata. Used by AggregationBuilder.rewrite(QueryRewriteContext).

Specified by:

shallowCopy in class AggregationBuilder

origin

public GeoPoint origin()

Return the GeoPoint that is used for distance computations.

innerWriteTo

protected void innerWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                     throws IOException

Description copied from class: ValuesSourceAggregationBuilder

Write subclass's state to the stream.

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>

Throws:

IOException

addRange

public GeoDistanceAggregationBuilder addRange(GeoDistanceAggregationBuilder.Range range)

addRange

public GeoDistanceAggregationBuilder addRange(String key,
 double from,
 double to)

Add a new range to this aggregation.

Parameters:

key - the key to use for this range in the response

from - the lower bound on the distances, inclusive

to - the upper bound on the distances, exclusive

addRange

public GeoDistanceAggregationBuilder addRange(double from,
 double to)

Same as addRange(String, double, double) but the key will be automatically generated based on from and to.

addUnboundedTo

public GeoDistanceAggregationBuilder addUnboundedTo(String key,
 double to)

Add a new range with no lower bound.

Parameters:

key - the key to use for this range in the response

to - the upper bound on the distances, exclusive

addUnboundedTo

public GeoDistanceAggregationBuilder addUnboundedTo(double to)

Same as addUnboundedTo(String, double) but the key will be computed automatically.

addUnboundedFrom

public GeoDistanceAggregationBuilder addUnboundedFrom(String key,
 double from)

Add a new range with no upper bound.

Parameters:

key - the key to use for this range in the response

from - the lower bound on the distances, inclusive

addUnboundedFrom

public GeoDistanceAggregationBuilder addUnboundedFrom(double from)

Same as addUnboundedFrom(String, double) but the key will be computed automatically.

range

public List<GeoDistanceAggregationBuilder.Range> range()

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

The name of the type of aggregation built by this builder.

getRegistryKey

protected ValuesSourceRegistry.RegistryKey<?> getRegistryKey()

Specified by:

getRegistryKey in class ValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>

unit

public GeoDistanceAggregationBuilder unit(DistanceUnit unit)

unit

public DistanceUnit unit()

distanceType

public GeoDistanceAggregationBuilder distanceType(GeoDistance distanceType)

distanceType

public GeoDistance distanceType()

keyed

public GeoDistanceAggregationBuilder keyed(boolean keyed)

keyed

public boolean keyed()

bucketCardinality

public AggregationBuilder.BucketCardinality bucketCardinality()

Description copied from class: AggregationBuilder

A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.

Specified by:

bucketCardinality in class AggregationBuilder

innerBuild

protected ValuesSourceAggregatorFactory innerBuild(QueryShardContext queryShardContext,
 ValuesSourceConfig config,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                                            throws IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>

Throws:

IOException

doXContentBody

protected org.opensearch.core.xcontent.XContentBuilder doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                               throws IOException

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class ValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class ValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>