Class IpRangeAggregationBuilder
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
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
,Rewriteable<AggregationBuilder>
,BaseAggregationBuilder
public final class IpRangeAggregationBuilder
extends ValuesSourceAggregationBuilder<IpRangeAggregationBuilder>
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,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.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Modifier and TypeFieldDescriptionstatic
static org.elasticsearch.common.xcontent.ObjectParser<>
Fields inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
config
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.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ModifierConstructorDescriptionname)
protected
IpRangeAggregationBuilder(IpRangeAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, <,> metadata)
-
Method Summary
Modifier and TypeMethodDescriptionmask)
Same asaddMaskRange(String, String)
but uses the mask itself as a key.key, mask)
Add a new range to this aggregation using the CIDR notation.from, to)
Same asaddRange(String, String, String)
but the key will be automatically generated.key, from, to)
Add a new range to this aggregation.Add a newIpRangeAggregationBuilder.Range
to this aggregation.from)
Same asaddUnboundedFrom(String, String)
but the key will be generated automatically.key, from)
Same asaddRange(String, String, String)
but there will be no upper bound.to)
Same asaddUnboundedTo(String, String)
but the key will be generated automatically.key, to)
Same asaddRange(String, String, String)
but there will be no lower bound.A rough count of the number of buckets thatAggregator
s built by this builder will contain per owning parent bucket.protected ValuesSourceType
Aggregations should use this method to define aValuesSourceType
of last resort.protected org.elasticsearch.common.xcontent.XContentBuilder
doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
boolean
obj)
Get the current list or ranges that are configured on this aggregation.protected ValuesSourceRegistry.RegistryKey<?>
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.boolean
keyed()
keyed(boolean keyed)
static void
Sets the script to use for this aggregation.protected AggregationBuilder
shallowCopy(AggregatorFactories.Builder factoriesBuilder, <,> metadata)
Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilder
andmetadata
.Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
declareFields, declareFields, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, 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, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getSubAggregations, rewrite, toString
Methods inherited from class java.lang.
, , , , , , ,
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
Field Details
-
NAME
public static final NAME- See Also:
- Constant Field Values
-
REGISTRY_KEY
-
PARSER
public static final org.elasticsearch.common.xcontent.ObjectParser<> PARSER
-
-
Constructor Details
-
IpRangeAggregationBuilder
public IpRangeAggregationBuilder( name) -
IpRangeAggregationBuilder
protected IpRangeAggregationBuilder(IpRangeAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, <,> metadata) -
IpRangeAggregationBuilder
- Throws:
-
-
Method Details
-
registerAggregators
-
shallowCopy
protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder, <,> 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
-
getType
public getType()Description copied from interface:BaseAggregationBuilder
The name of the type of aggregation built by this builder. -
getRegistryKey
- Specified by:
getRegistryKey
in classValuesSourceAggregationBuilder<IpRangeAggregationBuilder>
-
keyed
-
keyed
public boolean keyed() -
getRanges
Get the current list or ranges that are configured on this aggregation. -
addRange
Add a newIpRangeAggregationBuilder.Range
to this aggregation. -
addRange
public key, from, to)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
-
addMaskRange
public key, mask)Add a new range to this aggregation using the CIDR notation. -
addMaskRange
public mask)Same asaddMaskRange(String, String)
but uses the mask itself as a key. -
addRange
public from, to)Same asaddRange(String, String, String)
but the key will be automatically generated. -
addUnboundedTo
public key, to)Same asaddRange(String, String, String)
but there will be no lower bound. -
addUnboundedTo
public to)Same asaddUnboundedTo(String, String)
but the key will be generated automatically. -
addUnboundedFrom
public key, from)Same asaddRange(String, String, String)
but there will be no upper bound. -
script
Description copied from class:ValuesSourceAggregationBuilder
Sets the script to use for this aggregation.- Overrides:
script
in classValuesSourceAggregationBuilder<IpRangeAggregationBuilder>
-
addUnboundedFrom
public from)Same asaddUnboundedFrom(String, String)
but the key will be generated automatically. -
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<IpRangeAggregationBuilder>
- Returns:
- The CoreValuesSourceType we expect this script to yield.
-
innerWriteTo
Description copied from class:ValuesSourceAggregationBuilder
Write subclass's state to the stream.- Specified by:
innerWriteTo
in classValuesSourceAggregationBuilder<IpRangeAggregationBuilder>
- Throws:
-
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(AggregationContext context, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) throws- Specified by:
innerBuild
in classValuesSourceAggregationBuilder<IpRangeAggregationBuilder>
- Throws:
-
doXContentBody
protected org.elasticsearch.common.xcontent.XContentBuilder doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws- Specified by:
doXContentBody
in classValuesSourceAggregationBuilder<IpRangeAggregationBuilder>
- Throws:
-
hashCode
public int hashCode()- Overrides:
hashCode
in classValuesSourceAggregationBuilder<IpRangeAggregationBuilder>
-
equals
public boolean equals( obj)- Overrides:
equals
in classValuesSourceAggregationBuilder<IpRangeAggregationBuilder>
-