org.elasticsearch.search.aggregations.bucket.filters

Class InternalFilters.InternalBucket

java.lang.Object

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

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

All Implemented Interfaces:

Writeable, ToXContent, Filters.Bucket, MultiBucketsAggregation.Bucket, HasAggregations

Enclosing class:

InternalFilters

public static class InternalFilters.InternalBucket
extends InternalMultiBucketAggregation.InternalBucket
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>

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 inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
InternalBucket(StreamInput in, boolean keyed) Read from a stream.
InternalBucket(java.lang.String key, long docCount, InternalAggregations aggregations, boolean keyed)

Method Summary

Modifier and Type	Method and Description
Aggregations	getAggregations()
long	getDocCount()
java.lang.String	getKey()
java.lang.String	getKeyAsString()
XContentBuilder	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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

isFragment

Constructor Detail

InternalBucket

public InternalBucket(java.lang.String key,
                      long docCount,
                      InternalAggregations aggregations,
                      boolean keyed)

InternalBucket

public InternalBucket(StreamInput in,
                      boolean keyed)
               throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

getKey

public java.lang.String getKey()

Specified by:

getKey in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket

getKeyAsString

public java.lang.String getKeyAsString()

Specified by:

getKeyAsString in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket as a string

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException