Class GeoDistanceAggregationBuilder
java.lang.Object
org.opensearch.search.aggregations.AggregationBuilder
org.opensearch.search.aggregations.AbstractAggregationBuilder<AB>
org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>
org.opensearch.search.aggregations.bucket.range.GeoDistanceAggregationBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,org.opensearch.common.xcontent.ToXContent
,org.opensearch.common.xcontent.ToXContentFragment
,Rewriteable<AggregationBuilder>
,BaseAggregationBuilder
public class GeoDistanceAggregationBuilder extends ValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GeoDistanceAggregationBuilder.Range
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 java.lang.String
NAME
static ValuesSourceRegistry.RegistryKey<GeoDistanceAggregatorSupplier>
REGISTRY_KEY
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 Modifier Constructor Description GeoDistanceAggregationBuilder(java.lang.String name, GeoPoint origin)
GeoDistanceAggregationBuilder(StreamInput in)
Read from a stream.protected
GeoDistanceAggregationBuilder(GeoDistanceAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)
-
Method Summary
Modifier and Type Method Description GeoDistanceAggregationBuilder
addRange(double from, double to)
Same asaddRange(String, double, double)
but the key will be automatically generated based onfrom
andto
.GeoDistanceAggregationBuilder
addRange(java.lang.String key, double from, double to)
Add a new range to this aggregation.GeoDistanceAggregationBuilder
addRange(GeoDistanceAggregationBuilder.Range range)
GeoDistanceAggregationBuilder
addUnboundedFrom(double from)
Same asaddUnboundedFrom(String, double)
but the key will be computed automatically.GeoDistanceAggregationBuilder
addUnboundedFrom(java.lang.String key, double from)
Add a new range with no upper bound.GeoDistanceAggregationBuilder
addUnboundedTo(double to)
Same asaddUnboundedTo(String, double)
but the key will be computed automatically.GeoDistanceAggregationBuilder
addUnboundedTo(java.lang.String key, double to)
Add a new range with no lower bound.AggregationBuilder.BucketCardinality
bucketCardinality()
A rough count of the number of buckets thatAggregator
s built by this builder will contain per owning parent bucket.protected ValuesSourceType
defaultValueSourceType()
Aggregations should use this method to define aValuesSourceType
of last resort.GeoDistance
distanceType()
GeoDistanceAggregationBuilder
distanceType(GeoDistance distanceType)
protected org.opensearch.common.xcontent.XContentBuilder
doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
boolean
equals(java.lang.Object obj)
protected ValuesSourceRegistry.RegistryKey<?>
getRegistryKey()
java.lang.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(StreamOutput out)
Write subclass's state to the stream.boolean
keyed()
GeoDistanceAggregationBuilder
keyed(boolean keyed)
GeoPoint
origin()
Return theGeoPoint
that is used for distance computations.static AggregationBuilder
parse(java.lang.String aggregationName, org.opensearch.common.xcontent.XContentParser parser)
java.util.List<GeoDistanceAggregationBuilder.Range>
range()
static 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
.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
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
REGISTRY_KEY
-
-
Constructor Details
-
GeoDistanceAggregationBuilder
-
GeoDistanceAggregationBuilder
Read from a stream.- Throws:
java.io.IOException
-
GeoDistanceAggregationBuilder
protected GeoDistanceAggregationBuilder(GeoDistanceAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)
-
-
Method Details
-
parse
public static AggregationBuilder parse(java.lang.String aggregationName, org.opensearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
registerAggregators
-
defaultValueSourceType
Description copied from class:ValuesSourceAggregationBuilder
Aggregations should use this method to define aValuesSourceType
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 classValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>
- Returns:
- The CoreValuesSourceType we expect this script to yield.
-
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
-
origin
Return theGeoPoint
that is used for distance computations. -
innerWriteTo
Description copied from class:ValuesSourceAggregationBuilder
Write subclass's state to the stream.- Specified by:
innerWriteTo
in classValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>
- Throws:
java.io.IOException
-
addRange
-
addRange
Add a new range to this aggregation.- Parameters:
key
- the key to use for this range in the responsefrom
- the lower bound on the distances, inclusiveto
- the upper bound on the distances, exclusive
-
addRange
Same asaddRange(String, double, double)
but the key will be automatically generated based onfrom
andto
. -
addUnboundedTo
Add a new range with no lower bound.- Parameters:
key
- the key to use for this range in the responseto
- the upper bound on the distances, exclusive
-
addUnboundedTo
Same asaddUnboundedTo(String, double)
but the key will be computed automatically. -
addUnboundedFrom
Add a new range with no upper bound.- Parameters:
key
- the key to use for this range in the responsefrom
- the lower bound on the distances, inclusive
-
addUnboundedFrom
Same asaddUnboundedFrom(String, double)
but the key will be computed automatically. -
range
-
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<GeoDistanceAggregationBuilder>
-
unit
-
unit
-
distanceType
-
distanceType
-
keyed
-
keyed
public boolean keyed() -
bucketCardinality
Description copied from class:AggregationBuilder
A rough count of the number of buckets thatAggregator
s built by this builder will contain per owning parent bucket.- Specified by:
bucketCardinality
in classAggregationBuilder
-
innerBuild
protected ValuesSourceAggregatorFactory innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) throws java.io.IOException- Specified by:
innerBuild
in classValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>
- Throws:
java.io.IOException
-
doXContentBody
protected org.opensearch.common.xcontent.XContentBuilder doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
doXContentBody
in classValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>
- Throws:
java.io.IOException
-
hashCode
public int hashCode()- Overrides:
hashCode
in classValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>
-