Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.bucket.range

Class IpRangeAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<IpRangeAggregationBuilder>

org.elasticsearch.search.aggregations.bucket.range.IpRangeAggregationBuilder

All Implemented Interfaces:

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

public final class IpRangeAggregationBuilder
extends ValuesSourceAggregationBuilder<IpRangeAggregationBuilder>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IpRangeAggregationBuilder.Range

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

ValuesSourceAggregationBuilder.LeafOnly<AB extends ValuesSourceAggregationBuilder<AB>>, ValuesSourceAggregationBuilder.MetricsAggregationBuilder<AB extends ValuesSourceAggregationBuilder<AB>>, ValuesSourceAggregationBuilder.SingleMetricAggregationBuilder<AB extends ValuesSourceAggregationBuilder<AB>>

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final ObjectParser<IpRangeAggregationBuilder,String>	PARSER
static final ValuesSourceRegistry.RegistryKey<IpRangeAggregatorSupplier>	REGISTRY_KEY

Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

metadata

Fields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

DEFAULT_PREALLOCATION, factoriesBuilder, name

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	IpRangeAggregationBuilder(String name)
	IpRangeAggregationBuilder(StreamInput in)
protected	IpRangeAggregationBuilder(IpRangeAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
IpRangeAggregationBuilder	addMaskRange(String mask)	Same as addMaskRange(String, String) but uses the mask itself as a key.
IpRangeAggregationBuilder	addMaskRange(String key, String mask)	Add a new range to this aggregation using the CIDR notation.
IpRangeAggregationBuilder	addRange(String from, String to)	Same as addRange(String, String, String) but the key will be automatically generated.
IpRangeAggregationBuilder	addRange(String key, String from, String to)	Add a new range to this aggregation.
IpRangeAggregationBuilder	addRange(IpRangeAggregationBuilder.Range range)	Add a new IpRangeAggregationBuilder.Range to this aggregation.
IpRangeAggregationBuilder	addUnboundedFrom(String from)	Same as addUnboundedFrom(String, String) but the key will be generated automatically.
IpRangeAggregationBuilder	addUnboundedFrom(String key, String from)	Same as addRange(String, String, String) but there will be no upper bound.
IpRangeAggregationBuilder	addUnboundedTo(String to)	Same as addUnboundedTo(String, String) but the key will be generated automatically.
IpRangeAggregationBuilder	addUnboundedTo(String key, String to)	Same as addRange(String, String, String) but there will be 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.
protected XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object obj)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
protected ValuesSourceAggregatorFactory	innerBuild(AggregationContext context, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void	innerWriteTo(StreamOutput out)	Write subclass's state to the stream.
IpRangeAggregationBuilder	keyed(boolean keyed)
static void	registerAggregators(ValuesSourceRegistry.Builder builder)
IpRangeAggregationBuilder	script(Script script)	Sets the script to use for this aggregation.
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.
boolean	supportsSampling()	Does this aggregation support running with in a sampling context.

Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

declareFields, declareFields, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, resolveConfig, script, serializeTargetValueType, timeZone, timeZone, userValueTypeHint, userValueTypeHint

Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeTo

Methods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

buildPipelineTree, bytesToPreallocate, deepCopy, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getQuery, getSubAggregations, isInSortOrderExecutionRequired, rewrite, supportsParallelCollection, toString, validateSequentiallyOrdered, validateSequentiallyOrderedWithoutGaps

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

REGISTRY_KEY

public static final ValuesSourceRegistry.RegistryKey<IpRangeAggregatorSupplier> REGISTRY_KEY

PARSER

public static final ObjectParser<IpRangeAggregationBuilder,String> PARSER

Constructor Details

IpRangeAggregationBuilder

public IpRangeAggregationBuilder(String name)

IpRangeAggregationBuilder

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

IpRangeAggregationBuilder

public IpRangeAggregationBuilder(StreamInput in)
                          throws IOException

Throws:

IOException

Method Details

registerAggregators

public static void registerAggregators(ValuesSourceRegistry.Builder builder)

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.

Specified by:

shallowCopy in class AggregationBuilder

supportsSampling

public boolean supportsSampling()

Description copied from class: AggregationBuilder

Does this aggregation support running with in a sampling context. By default, it's false for all aggregations. If the sub-classed builder supports sampling, be sure of the following that the resulting internal aggregation objects override the InternalAggregation.finalizeSampling(SamplingContext) and scales any values that require scaling.

Overrides:

supportsSampling in class AggregationBuilder

Returns:

does this aggregation builder support sampling

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

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

keyed

public IpRangeAggregationBuilder keyed(boolean keyed)

addRange

public IpRangeAggregationBuilder addRange(IpRangeAggregationBuilder.Range range)

Add a new IpRangeAggregationBuilder.Range to this aggregation.

addRange

public IpRangeAggregationBuilder addRange(String key,
 String from,
 String 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

addMaskRange

public IpRangeAggregationBuilder addMaskRange(String key,
 String mask)

Add a new range to this aggregation using the CIDR notation.

addMaskRange

public IpRangeAggregationBuilder addMaskRange(String mask)

Same as addMaskRange(String, String) but uses the mask itself as a key.

addRange

public IpRangeAggregationBuilder addRange(String from,
 String to)

Same as addRange(String, String, String) but the key will be automatically generated.

addUnboundedTo

public IpRangeAggregationBuilder addUnboundedTo(String key,
 String to)

Same as addRange(String, String, String) but there will be no lower bound.

addUnboundedTo

public IpRangeAggregationBuilder addUnboundedTo(String to)

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

addUnboundedFrom

public IpRangeAggregationBuilder addUnboundedFrom(String key,
 String from)

Same as addRange(String, String, String) but there will be no upper bound.

script

public IpRangeAggregationBuilder script(Script script)

Description copied from class: ValuesSourceAggregationBuilder

Sets the script to use for this aggregation.

Overrides:

script in class ValuesSourceAggregationBuilder<IpRangeAggregationBuilder>

addUnboundedFrom

public IpRangeAggregationBuilder addUnboundedFrom(String from)

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

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<IpRangeAggregationBuilder>

Returns:

The CoreValuesSourceType we expect this script to yield.

innerWriteTo

protected void innerWriteTo(StreamOutput out)
                     throws IOException

Description copied from class: ValuesSourceAggregationBuilder

Write subclass's state to the stream.

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<IpRangeAggregationBuilder>

Throws:

IOException

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(AggregationContext context,
 ValuesSourceConfig config,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                                            throws IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<IpRangeAggregationBuilder>

Throws:

IOException

doXContentBody

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

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<IpRangeAggregationBuilder>

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class ValuesSourceAggregationBuilder<IpRangeAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class ValuesSourceAggregationBuilder<IpRangeAggregationBuilder>

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to