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 alter the document set used for sub aggregations it precedes to nested documents found in the field specified.

Field Summary

Fields

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

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

discriminatorMapping, discriminatorPropertyName, type

Constructor Summary

Constructors

Constructor and Description
QueryNestedAggregation()

Method Summary

Methods

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

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

Field Detail

path

protected java.lang.String path

matchingResults

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

aggregations

protected java.util.List<QueryAggregation> aggregations

Constructor Detail

QueryNestedAggregation

public QueryNestedAggregation()

Method Detail

getPath

public java.lang.String getPath()

Gets the path.

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

Returns:

the path

getMatchingResults

public java.lang.Long getMatchingResults()

Gets the matchingResults.

Number of nested documents found in the specified field.

Returns:

the matchingResults

getAggregations

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

Gets the aggregations.

An array of sub aggregations.

Returns:

the aggregations