org.elasticsearch.search.aggregations.bucket.filters

Interface Filters

All Superinterfaces:

Aggregation, MultiBucketsAggregation

All Known Implementing Classes:

InternalFilters

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 and Description
static interface	Filters.Bucket A bucket associated with a specific filter (identified by its key)

Method Summary

Modifier and Type	Method and Description
Filters.Bucket	getBucketByKey(String key) The bucket that is associated with the given key.
Collection<? extends Filters.Bucket>	getBuckets() The buckets created by this aggregation.

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

getName

Method Detail

getBuckets

Collection<? 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(String key)

Description copied from interface: MultiBucketsAggregation

The bucket that is associated with the given key.

Specified by:

getBucketByKey in interface MultiBucketsAggregation

Parameters:

key - The key of the requested bucket.

Returns:

The bucket