Class IpRangeAggregationBuilder
java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>
org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ValuesSource.Bytes,IpRangeAggregationBuilder>
org.elasticsearch.search.aggregations.bucket.range.IpRangeAggregationBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,ToXContent
,ToXContentFragment
,BaseAggregationBuilder
public final class IpRangeAggregationBuilder extends ValuesSourceAggregationBuilder<ValuesSource.Bytes,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<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<VS,AB>>
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
AggregationBuilder.CommonFields
Nested classes/interfaces inherited from interface org.elasticsearch.common.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 java.lang.String
NAME
static ObjectParser<IpRangeAggregationBuilder,java.lang.String>
PARSER
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
factoriesBuilder, name
-
Constructor Summary
Constructors Modifier Constructor Description IpRangeAggregationBuilder(java.lang.String name)
IpRangeAggregationBuilder(StreamInput in)
protected
IpRangeAggregationBuilder(IpRangeAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)
-
Method Summary
Modifier and Type Method Description IpRangeAggregationBuilder
addMaskRange(java.lang.String mask)
Same asaddMaskRange(String, String)
but uses the mask itself as a key.IpRangeAggregationBuilder
addMaskRange(java.lang.String key, java.lang.String mask)
Add a new range to this aggregation using the CIDR notation.IpRangeAggregationBuilder
addRange(java.lang.String from, java.lang.String to)
Same asaddRange(String, String, String)
but the key will be automatically generated.IpRangeAggregationBuilder
addRange(java.lang.String key, java.lang.String from, java.lang.String to)
Add a new range to this aggregation.IpRangeAggregationBuilder
addRange(IpRangeAggregationBuilder.Range range)
Add a newIpRangeAggregationBuilder.Range
to this aggregation.IpRangeAggregationBuilder
addUnboundedFrom(java.lang.String from)
Same asaddUnboundedFrom(String, String)
but the key will be generated automatically.IpRangeAggregationBuilder
addUnboundedFrom(java.lang.String key, java.lang.String from)
Same asaddRange(String, String, String)
but there will be no upper bound.IpRangeAggregationBuilder
addUnboundedTo(java.lang.String to)
Same asaddUnboundedTo(String, String)
but the key will be generated automatically.IpRangeAggregationBuilder
addUnboundedTo(java.lang.String key, java.lang.String to)
Same asaddRange(String, String, String)
but there will be no lower bound.protected XContentBuilder
doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean
equals(java.lang.Object obj)
java.util.List<IpRangeAggregationBuilder.Range>
getRanges()
Get the current list or ranges that are configured on this aggregation.java.lang.String
getType()
The name of the type of aggregation built by this builder.int
hashCode()
protected ValuesSourceAggregatorFactory<ValuesSource.Bytes>
innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig<ValuesSource.Bytes> config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void
innerWriteTo(StreamOutput out)
Write subclass's state to the stream.boolean
keyed()
IpRangeAggregationBuilder
keyed(boolean keyed)
IpRangeAggregationBuilder
script(Script script)
Sets the script to use for this aggregation.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
.Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
defaultValueType, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, resolveScriptAny, script, serializeTargetValueType, timeZone, timeZone, valueType, valueType
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, doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
PARSER
-
-
Constructor Details
-
IpRangeAggregationBuilder
public IpRangeAggregationBuilder(java.lang.String name) -
IpRangeAggregationBuilder
protected IpRangeAggregationBuilder(IpRangeAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData) -
IpRangeAggregationBuilder
- Throws:
java.io.IOException
-
-
Method Details
-
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
-
getType
public java.lang.String getType()Description copied from interface:BaseAggregationBuilder
The name of the type of aggregation built by this builder. -
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 IpRangeAggregationBuilder addRange(java.lang.String key, java.lang.String from, java.lang.String 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
Add a new range to this aggregation using the CIDR notation. -
addMaskRange
Same asaddMaskRange(String, String)
but uses the mask itself as a key. -
addRange
Same asaddRange(String, String, String)
but the key will be automatically generated. -
addUnboundedTo
Same asaddRange(String, String, String)
but there will be no lower bound. -
addUnboundedTo
Same asaddUnboundedTo(String, String)
but the key will be generated automatically. -
addUnboundedFrom
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<ValuesSource.Bytes,IpRangeAggregationBuilder>
-
addUnboundedFrom
Same asaddUnboundedFrom(String, String)
but the key will be generated automatically. -
innerWriteTo
Description copied from class:ValuesSourceAggregationBuilder
Write subclass's state to the stream.- Specified by:
innerWriteTo
in classValuesSourceAggregationBuilder<ValuesSource.Bytes,IpRangeAggregationBuilder>
- Throws:
java.io.IOException
-
innerBuild
protected ValuesSourceAggregatorFactory<ValuesSource.Bytes> innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig<ValuesSource.Bytes> config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) throws java.io.IOException- Specified by:
innerBuild
in classValuesSourceAggregationBuilder<ValuesSource.Bytes,IpRangeAggregationBuilder>
- Throws:
java.io.IOException
-
doXContentBody
protected XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
doXContentBody
in classValuesSourceAggregationBuilder<ValuesSource.Bytes,IpRangeAggregationBuilder>
- Throws:
java.io.IOException
-
hashCode
public int hashCode()- Overrides:
hashCode
in classValuesSourceAggregationBuilder<ValuesSource.Bytes,IpRangeAggregationBuilder>
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classValuesSourceAggregationBuilder<ValuesSource.Bytes,IpRangeAggregationBuilder>
-