org.elasticsearch.search.aggregations.bucket.range.ipv4

Class IPv4RangeBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

org.elasticsearch.search.aggregations.AggregationBuilder<B>

org.elasticsearch.search.aggregations.ValuesSourceAggregationBuilder<B>

org.elasticsearch.search.aggregations.bucket.range.AbstractRangeBuilder<IPv4RangeBuilder>

org.elasticsearch.search.aggregations.bucket.range.ipv4.IPv4RangeBuilder

All Implemented Interfaces:

ToXContent

public class IPv4RangeBuilder
extends AbstractRangeBuilder<IPv4RangeBuilder>

Builder for the IPv4Range aggregation.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.bucket.range.AbstractRangeBuilder

AbstractRangeBuilder.Range

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

ranges

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

type

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
IPv4RangeBuilder(String name) Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
IPv4RangeBuilder	addMaskRange(String mask) Same as addMaskRange(String, String) but uses the mask itself as a key.
IPv4RangeBuilder	addMaskRange(String key, String mask) Add a range based on a CIDR mask.
IPv4RangeBuilder	addRange(String from, String to) Same as addRange(String, String, String) but the key will be automatically generated.
IPv4RangeBuilder	addRange(String key, String from, String to) Add a new range to this aggregation.
IPv4RangeBuilder	addUnboundedFrom(String from) Same as addUnboundedFrom(String, String) but the key will be generated automatically.
IPv4RangeBuilder	addUnboundedFrom(String key, String from) Same as addRange(String, String, String) but there will be no upper bound.
IPv4RangeBuilder	addUnboundedTo(String to) Same as addUnboundedTo(String, String) but the key will be generated automatically.
IPv4RangeBuilder	addUnboundedTo(String key, String to) Same as addRange(String, String, String) but there will be no lower bound.

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

doInternalXContent

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

field, internalXContent, missing, script

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

setMetaData, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, toXContent

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

getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IPv4RangeBuilder

public IPv4RangeBuilder(String name)

Sole constructor.

Method Detail

addRange

public IPv4RangeBuilder 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 IPv4RangeBuilder addMaskRange(String mask)

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

addMaskRange

public IPv4RangeBuilder addMaskRange(String key,
                            String mask)

Add a range based on a CIDR mask.

addRange

public IPv4RangeBuilder addRange(String from,
                        String to)

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

addUnboundedTo

public IPv4RangeBuilder addUnboundedTo(String key,
                              String to)

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

addUnboundedTo

public IPv4RangeBuilder addUnboundedTo(String to)

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

addUnboundedFrom

public IPv4RangeBuilder addUnboundedFrom(String key,
                                String from)

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

addUnboundedFrom

public IPv4RangeBuilder addUnboundedFrom(String from)

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