org.elasticsearch.search.aggregations.bucket.filter

Class FilterAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

org.elasticsearch.search.aggregations.AggregationBuilder<FilterAggregationBuilder>

org.elasticsearch.search.aggregations.bucket.filter.FilterAggregationBuilder

All Implemented Interfaces:

ToXContent

public class FilterAggregationBuilder
extends AggregationBuilder<FilterAggregationBuilder>

Builder for the Filter aggregation.

Nested Class Summary

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.AbstractAggregationBuilder

type

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
FilterAggregationBuilder(String name) Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
FilterAggregationBuilder	filter(QueryBuilder filter) Set the filter to use, only documents that match this filter will fall into the bucket defined by this Filter aggregation.
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

setMetaData, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, toXContent

Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterAggregationBuilder

public FilterAggregationBuilder(String name)

Sole constructor.

Method Detail

filter

public FilterAggregationBuilder filter(QueryBuilder filter)

Set the filter to use, only documents that match this filter will fall into the bucket defined by this Filter aggregation.

internalXContent

protected XContentBuilder internalXContent(XContentBuilder builder,
                               ToXContent.Params params)
                                    throws IOException

Specified by:

internalXContent in class AggregationBuilder<FilterAggregationBuilder>

Throws:

IOException