org.elasticsearch.search.aggregations.bucket.terms

Class StringTerms.Bucket

java.lang.Object

org.elasticsearch.search.aggregations.bucket.terms.Terms.Bucket

org.elasticsearch.search.aggregations.bucket.terms.InternalTerms.Bucket

org.elasticsearch.search.aggregations.bucket.terms.StringTerms.Bucket

All Implemented Interfaces:

MultiBucketsAggregation.Bucket, HasAggregations

Enclosing class:

StringTerms

public static class StringTerms.Bucket
extends InternalTerms.Bucket

Nested Class Summary

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

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

Field Summary

Fields inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalTerms.Bucket

aggregations, docCount, docCountError, showDocCountError

Constructor Summary

Constructors

Constructor and Description
Bucket(org.apache.lucene.util.BytesRef term, long docCount, InternalAggregations aggregations, boolean showDocCountError, long docCountError)

Method Summary

Modifier and Type	Method and Description
String	getKey()
Number	getKeyAsNumber()
Text	getKeyAsText()

Methods inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalTerms.Bucket

getAggregations, getDocCount, getDocCountError, reduce

Methods inherited from class java.lang.Object

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

Constructor Detail

Bucket

public Bucket(org.apache.lucene.util.BytesRef term,
              long docCount,
              InternalAggregations aggregations,
              boolean showDocCountError,
              long docCountError)

Method Detail

getKey

public String getKey()

Returns:

The key associated with the bucket as a string

getKeyAsText

public Text getKeyAsText()

Returns:

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

getKeyAsNumber

public Number getKeyAsNumber()

Specified by:

getKeyAsNumber in class Terms.Bucket