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 will narrow down the document set of the sub aggregations it precedes.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<QueryAggregation>	aggregations
protected java.lang.String	match
protected java.lang.Long	matchingResults

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

discriminatorMapping, discriminatorPropertyName, type

Constructor Summary

Constructors

Constructor and Description
QueryFilterAggregation()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<QueryAggregation>	getAggregations() Gets the aggregations.
java.lang.String	getMatch() Gets the match.
java.lang.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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

match

protected java.lang.String match

matchingResults

@SerializedName(value="matching_results")
protected java.lang.Long matchingResults

aggregations

protected java.util.List<QueryAggregation> aggregations

Constructor Detail

QueryFilterAggregation

public QueryFilterAggregation()

Method Detail

getMatch

public java.lang.String getMatch()

Gets the match.

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

Returns:

the match

getMatchingResults

public java.lang.Long getMatchingResults()

Gets the matchingResults.

Number of documents matching the filter.

Returns:

the matchingResults

getAggregations

public java.util.List<QueryAggregation> getAggregations()

Gets the aggregations.

An array of sub aggregations.

Returns:

the aggregations