org.elasticsearch.search.aggregations.bucket.terms

Class StringTerms.Bucket

java.lang.Object

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

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:

Streamable, ToXContent, 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>

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

aggregations, docCount, docCountError, showDocCountError

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Object	getKey()
Number	getKeyAsNumber()
String	getKeyAsString()
void	readFrom(StreamInput in)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

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

getAggregations, getDocCount, getDocCountError, reduce

Methods inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

getProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

StringTerms.Bucket

public StringTerms.Bucket(boolean showDocCountError)

StringTerms.Bucket

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

Method Detail

getKey

public Object getKey()

Returns:

The key associated with the bucket

getKeyAsNumber

public Number getKeyAsNumber()

Specified by:

getKeyAsNumber in class Terms.Bucket

getKeyAsString

public String getKeyAsString()

Returns:

The key associated with the bucket as a string

readFrom

public void readFrom(StreamInput in)
              throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Throws:

IOException