org.elasticsearch.search.aggregations.bucket.filters

Class InternalFilters.Bucket

java.lang.Object

org.elasticsearch.search.aggregations.bucket.filters.InternalFilters.Bucket

All Implemented Interfaces:

Filters.Bucket, MultiBucketsAggregation.Bucket, HasAggregations

Enclosing class:

InternalFilters

public static class InternalFilters.Bucket
extends Object
implements Filters.Bucket

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket

MultiBucketsAggregation.Bucket.SubAggregationComparator<B extends MultiBucketsAggregation.Bucket>

Constructor Summary

Constructors

Constructor and Description
Bucket(String key, long docCount, InternalAggregations aggregations)

Method Summary

Modifier and Type	Method and Description
Aggregations	getAggregations()
long	getDocCount()
String	getKey()
Text	getKeyAsText()

Methods inherited from class java.lang.Object

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

Constructor Detail

Bucket

public Bucket(String key,
              long docCount,
              InternalAggregations aggregations)

Method Detail

getKey

public String getKey()

Specified by:

getKey in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket as a string

getKeyAsText

public Text getKeyAsText()

Specified by:

getKeyAsText in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket as text (ideal for further streaming this instance)

getDocCount

public long getDocCount()

Specified by:

getDocCount in interface MultiBucketsAggregation.Bucket

Returns:

The number of documents that fall within this bucket

getAggregations

public Aggregations getAggregations()

Specified by:

getAggregations in interface MultiBucketsAggregation.Bucket

Specified by:

getAggregations in interface HasAggregations

Returns:

The sub-aggregations of this bucket