com.ibm.watson.discovery.v2.model

Class QueryAggregation

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

QueryAggregationQueryCalculationAggregation, QueryAggregationQueryFilterAggregation, QueryAggregationQueryGroupByAggregation, QueryAggregationQueryHistogramAggregation, QueryAggregationQueryNestedAggregation, QueryAggregationQueryPairAggregation, QueryAggregationQueryTermAggregation, QueryAggregationQueryTimesliceAggregation, QueryAggregationQueryTopHitsAggregation, QueryAggregationQueryTopicAggregation, QueryAggregationQueryTrendAggregation

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

An object that defines how to aggregate query results.

Classes which extend this class: - QueryAggregationQueryTermAggregation - QueryAggregationQueryGroupByAggregation - QueryAggregationQueryHistogramAggregation - QueryAggregationQueryTimesliceAggregation - QueryAggregationQueryNestedAggregation - QueryAggregationQueryFilterAggregation - QueryAggregationQueryCalculationAggregation - QueryAggregationQueryTopHitsAggregation - QueryAggregationQueryPairAggregation - QueryAggregationQueryTrendAggregation - QueryAggregationQueryTopicAggregation

Method Summary

Modifier and Type	Method and Description
List<Map<String,Object>>	getAggregations() Gets the aggregations.
Long	getCount() Gets the count.
String	getFacet() Gets the facet.
String	getField() Gets the field.
String	getFirst() Gets the first.
QueryTopHitsAggregationResult	getHits() Gets the hits.
String	getMatch() Gets the match.
Long	getMatchingResults() Gets the matchingResults.
String	getName() Gets the name.
String	getPath() Gets the path.
String	getSecond() Gets the second.
Long	getSize() Gets the size.
String	getTimeSegments() Gets the timeSegments.
String	getType() Gets the type.
Double	getValue() Gets the value.
Boolean	isShowEstimatedMatchingResults() Gets the showEstimatedMatchingResults.
Boolean	isShowTotalMatchingDocuments() Gets the showTotalMatchingDocuments.

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

Method Detail

getType

public String getType()

Gets the type.

Specifies that the aggregation type is `term`.

Returns:

the type

getField

public String getField()

Gets the field.

The field in the document where the values come from.

Returns:

the field

getCount

public Long getCount()

Gets the count.

The number of results returned. Not returned if `relevancy:true` is specified in the request.

Returns:

the count

getName

public String getName()

Gets the name.

Identifier specified in the query request of this aggregation. Not returned if `relevancy:true` is specified in the request.

Returns:

the name

getPath

public String getPath()

Gets the path.

The path to the document field to scope subsequent 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<Map<String,Object>> getAggregations()

Gets the aggregations.

An array of subaggregations.

Returns:

the aggregations

getMatch

public String getMatch()

Gets the match.

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

Returns:

the match

getValue

public Double getValue()

Gets the value.

The value of the calculation.

Returns:

the value

getSize

public Long getSize()

Gets the size.

The number of documents to return.

Returns:

the size

getHits

public QueryTopHitsAggregationResult getHits()

Gets the hits.

A query response that contains the matching documents for the preceding aggregations.

Returns:

the hits

getFirst

public String getFirst()

Gets the first.

Specifies the first aggregation in the pair. The aggregation must be a `term`, `group_by`, `histogram`, or `timeslice` aggregation type.

Returns:

the first

getSecond

public String getSecond()

Gets the second.

Specifies the second aggregation in the pair. The aggregation must be a `term`, `group_by`, `histogram`, or `timeslice` aggregation type.

Returns:

the second

isShowEstimatedMatchingResults

public Boolean isShowEstimatedMatchingResults()

Gets the showEstimatedMatchingResults.

Indicates whether to include estimated matching result information.

Returns:

the showEstimatedMatchingResults

isShowTotalMatchingDocuments

public Boolean isShowTotalMatchingDocuments()

Gets the showTotalMatchingDocuments.

Indicates whether to include total matching documents information.

Returns:

the showTotalMatchingDocuments

getFacet

public String getFacet()

Gets the facet.

Specifies the `term` or `group_by` aggregation for the facet that you want to analyze.

Returns:

the facet

getTimeSegments

public String getTimeSegments()

Gets the timeSegments.

Specifies the `timeslice` aggregation that defines the time segments.

Returns:

the timeSegments