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

Class RangeAggregationBuilder

java.lang.Object

org.opensearch.search.aggregations.AggregationBuilder

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

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

org.opensearch.search.aggregations.bucket.range.AbstractRangeBuilder<RangeAggregationBuilder,RangeAggregator.Range>

org.opensearch.search.aggregations.bucket.range.RangeAggregationBuilder

All Implemented Interfaces:

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

public class RangeAggregationBuilder
extends AbstractRangeBuilder<RangeAggregationBuilder,RangeAggregator.Range>

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

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 org.opensearch.common.xcontent.ObjectParser<RangeAggregationBuilder,java.lang.String>	PARSER
static ValuesSourceRegistry.RegistryKey<RangeAggregatorSupplier>	REGISTRY_KEY

Fields inherited from class org.opensearch.search.aggregations.bucket.range.AbstractRangeBuilder

keyed, rangeFactory, ranges

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
	RangeAggregationBuilder(java.lang.String name)
	RangeAggregationBuilder(StreamInput in)	Read from a stream.
protected	RangeAggregationBuilder(RangeAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)

Method Summary

Modifier and Type	Method	Description
RangeAggregationBuilder	addRange(double from, double to)	Same as addRange(String, double, double) but the key will be automatically generated based on from and to.
RangeAggregationBuilder	addRange(java.lang.String key, double from, double to)	Add a new range to this aggregation.
RangeAggregationBuilder	addUnboundedFrom(double from)	Same as addUnboundedFrom(String, double) but the key will be computed automatically.
RangeAggregationBuilder	addUnboundedFrom(java.lang.String key, double from)	Add a new range with no upper bound.
RangeAggregationBuilder	addUnboundedTo(double to)	Same as addUnboundedTo(String, double) but the key will be computed automatically.
RangeAggregationBuilder	addUnboundedTo(java.lang.String key, double to)	Add a new range with no lower bound.
protected ValuesSourceRegistry.RegistryKey<?>	getRegistryKey()
java.lang.String	getType()	The name of the type of aggregation built by this builder.
protected RangeAggregatorFactory	innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
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 replacing AggregationBuilder.factoriesBuilder and metadata.

Methods inherited from class org.opensearch.search.aggregations.bucket.range.AbstractRangeBuilder

addRange, bucketCardinality, defaultValueSourceType, doXContentBody, equals, hashCode, innerWriteTo, keyed, keyed, processRanges, ranges

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 java.lang.String NAME

See Also:

Constant Field Values

REGISTRY_KEY

public static final ValuesSourceRegistry.RegistryKey<RangeAggregatorSupplier> REGISTRY_KEY

PARSER

public static final org.opensearch.common.xcontent.ObjectParser<RangeAggregationBuilder,java.lang.String> PARSER

Constructor Details

RangeAggregationBuilder

public RangeAggregationBuilder(java.lang.String name)

RangeAggregationBuilder

public RangeAggregationBuilder(StreamInput in) throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

RangeAggregationBuilder

protected RangeAggregationBuilder(RangeAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)

Method Details

registerAggregators

public static void registerAggregators(ValuesSourceRegistry.Builder builder)

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 replacing AggregationBuilder.factoriesBuilder and metadata. Used by AggregationBuilder.rewrite(QueryRewriteContext).

Specified by:

shallowCopy in class AggregationBuilder

addRange

public RangeAggregationBuilder addRange(java.lang.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 RangeAggregationBuilder 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 RangeAggregationBuilder addUnboundedTo(java.lang.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 RangeAggregationBuilder addUnboundedTo(double to)

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

addUnboundedFrom

public RangeAggregationBuilder addUnboundedFrom(java.lang.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 RangeAggregationBuilder addUnboundedFrom(double from)

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

innerBuild

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

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<RangeAggregationBuilder>

Throws:

java.io.IOException

getType

public java.lang.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<RangeAggregationBuilder>