Package org.elasticsearch.search.aggregations.bucket.filter

Interface Filters

All Superinterfaces:

Aggregation, MultiBucketsAggregation, ToXContent, ToXContentFragment

All Known Implementing Classes:

InternalFilters, ParsedFilters

public interface Filters
extends MultiBucketsAggregation

A multi bucket aggregation where the buckets are defined by a set of filters (a bucket per filter). Each bucket will collect all documents matching its filter.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Filters.Bucket	A bucket associated with a specific filter (identified by its key)

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

Aggregation.CommonFields

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
Filters.Bucket	getBucketByKey(java.lang.String key)
java.util.List<? extends Filters.Bucket>	getBuckets()	The buckets created by this aggregation.

Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

getMetaData, getName, getType

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

toXContent

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

isFragment

Method Detail

getBuckets

java.util.List<? extends Filters.Bucket> getBuckets()

The buckets created by this aggregation.

Specified by:

getBuckets in interface MultiBucketsAggregation

Returns:

The buckets of this aggregation.

getBucketByKey

Filters.Bucket getBucketByKey(java.lang.String key)