Module org.elasticsearch.server
Class InternalIpPrefix.Bucket
java.lang.Object
org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket
org.elasticsearch.search.aggregations.bucket.prefix.InternalIpPrefix.Bucket
- All Implemented Interfaces:
Writeable
,MultiBucketsAggregation.Bucket
,IpPrefix.Bucket
,HasAggregations
,KeyComparable<InternalIpPrefix.Bucket>
,ToXContent
- Enclosing class:
- InternalIpPrefix
public static class InternalIpPrefix.Bucket
extends InternalMultiBucketAggregation.InternalBucket
implements IpPrefix.Bucket, KeyComparable<InternalIpPrefix.Bucket>
-
Nested Class Summary
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 inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionBucket
(StreamInput in, DocValueFormat format, boolean keyed) Read from a stream.Bucket
(DocValueFormat format, org.apache.lucene.util.BytesRef key, boolean keyed, boolean isIpv6, int prefixLength, boolean appendPrefixLength, long docCount, InternalAggregations aggregations) -
Method Summary
Modifier and TypeMethodDescriptionboolean
int
Compare thisMultiBucketsAggregation.Bucket
skey
with another bucket.boolean
long
org.apache.lucene.util.BytesRef
getKey()
int
int
hashCode()
boolean
isIpv6()
toXContent
(XContentBuilder builder, ToXContent.Params params) void
writeTo
(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket
getProperty
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.xcontent.ToXContent
isFragment
-
Constructor Details
-
Bucket
public Bucket(DocValueFormat format, org.apache.lucene.util.BytesRef key, boolean keyed, boolean isIpv6, int prefixLength, boolean appendPrefixLength, long docCount, InternalAggregations aggregations) -
Bucket
Read from a stream.- Throws:
IOException
-
-
Method Details
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceToXContent
- Throws:
IOException
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
getFormat
-
getKey
public org.apache.lucene.util.BytesRef getKey()- Specified by:
getKey
in interfaceMultiBucketsAggregation.Bucket
- Returns:
- The key associated with the bucket
-
getKeyAsString
- Specified by:
getKeyAsString
in interfaceMultiBucketsAggregation.Bucket
- Returns:
- The key associated with the bucket as a string
-
isIpv6
public boolean isIpv6() -
getPrefixLength
public int getPrefixLength() -
appendPrefixLength
public boolean appendPrefixLength() -
getDocCount
public long getDocCount()- Specified by:
getDocCount
in interfaceMultiBucketsAggregation.Bucket
- Returns:
- The number of documents that fall within this bucket
-
getAggregations
- Specified by:
getAggregations
in interfaceHasAggregations
- Specified by:
getAggregations
in interfaceMultiBucketsAggregation.Bucket
- Returns:
- The sub-aggregations of this bucket
-
equals
-
hashCode
public int hashCode() -
compareKey
Description copied from interface:KeyComparable
Compare thisMultiBucketsAggregation.Bucket
skey
with another bucket.- Specified by:
compareKey
in interfaceKeyComparable<InternalIpPrefix.Bucket>
- Parameters:
other
- the bucket that contains the key to compare to.- Returns:
- a negative integer, zero, or a positive integer as this buckets key is less than, equal to, or greater than the other buckets key.
- See Also:
-