Package com.ibm.watson.discovery.v2.model

Class QueryFilterAggregation

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.discovery.v2.model.QueryAggregation

com.ibm.watson.discovery.v2.model.QueryFilterAggregation

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class QueryFilterAggregation
extends QueryAggregation

A modifier that narrows the document set of the sub-aggregations it precedes.

Constructor Summary

Constructors

Constructor	Description
QueryFilterAggregation()

Method Summary

Modifier and Type	Method	Description
List<QueryAggregation>	getAggregations()	Gets the aggregations.
String	getMatch()	Gets the match.
Long	getMatchingResults()	Gets the matchingResults.

Methods inherited from class com.ibm.watson.discovery.v2.model.QueryAggregation

getType

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

QueryFilterAggregation

public QueryFilterAggregation()

Method Details

getMatch

public String getMatch()

Gets the match.

The filter that is written in Discovery Query Language syntax and is applied to the documents before sub-aggregations are run.

Returns:

the match

getMatchingResults

public Long getMatchingResults()

Gets the matchingResults.

Number of documents that match the filter.

Returns:

the matchingResults

getAggregations

public List<QueryAggregation> getAggregations()

Gets the aggregations.

An array of sub-aggregations.

Returns:

the aggregations