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

Class QueryNestedAggregation

java.lang.Object

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

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

com.ibm.watson.discovery.v2.model.QueryNestedAggregation

All Implemented Interfaces:

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

public class QueryNestedAggregation
extends QueryAggregation

A restriction that alters the document set that is used for sub-aggregations it precedes to nested documents found in the field specified.

Constructor Summary

Constructors

Constructor	Description
QueryNestedAggregation()

Method Summary

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

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

QueryNestedAggregation

public QueryNestedAggregation()

Method Details

getPath

public String getPath()

Gets the path.

The path to the document field to scope sub-aggregations to.

Returns:

the path

getMatchingResults

public Long getMatchingResults()

Gets the matchingResults.

Number of nested documents found in the specified field.

Returns:

the matchingResults

getAggregations

public List<QueryAggregation> getAggregations()

Gets the aggregations.

An array of sub-aggregations.

Returns:

the aggregations