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

com.ibm.watson.discovery.v2.model.QueryGroupByAggregationResult

All Implemented Interfaces:: com.ibm.cloud.sdk.core.service.model.ObjectModel

public class QueryGroupByAggregationResult
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Top value result for the term aggregation.

Method Summary

Modifier and Type	Method	Description
`List<QueryAggregation>`	`getAggregations()`	Gets the aggregations.
`Long`	`getEstimatedMatchingDocuments()`	Gets the estimatedMatchingDocuments.
`String`	`getKey()`	Gets the key.
`Long`	`getMatchingResults()`	Gets the matchingResults.
`Double`	`getRelevancy()`	Gets the relevancy.
`Long`	`getTotalMatchingDocuments()`	Gets the totalMatchingDocuments.

equals, hashCode, toString

getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- QueryGroupByAggregationResult
  
  public QueryGroupByAggregationResult()
Method Details
- getKey
  
  public String getKey()
  
  Gets the key.
  Value of the field with a non-zero frequency in the document set.
  
  Returns:
  
  the key
- getMatchingResults
  
  public Long getMatchingResults()
  
  Gets the matchingResults.
  Number of documents that contain the 'key'.
  
  Returns:
  
  the matchingResults
- getRelevancy
  
  public Double getRelevancy()
  
  Gets the relevancy.
  The relevancy for this group.
  
  Returns:
  
  the relevancy
- getTotalMatchingDocuments
  
  public Long getTotalMatchingDocuments()
  
  Gets the totalMatchingDocuments.
  The number of documents which have the group as the value of specified field in the whole set of documents in this collection. Returned only when the `relevancy` parameter is set to `true`.
  
  Returns:
  
  the totalMatchingDocuments
- getEstimatedMatchingDocuments
  
  public Long getEstimatedMatchingDocuments()
  
  Gets the estimatedMatchingDocuments.
  The estimated number of documents which would match the query and also meet the condition. Returned only when the `relevancy` parameter is set to `true`.
  
  Returns:
  
  the estimatedMatchingDocuments
- getAggregations
  
  public List<QueryAggregation> getAggregations()
  
  Gets the aggregations.
  An array of sub-aggregations.
  
  Returns:
  
  the aggregations

Class QueryGroupByAggregationResult