com.ibm.watson.discovery.v2.model

Class QueryTopHitsAggregation

java.lang.Object

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

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

com.ibm.watson.discovery.v2.model.QueryTopHitsAggregation

All Implemented Interfaces:

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

public class QueryTopHitsAggregation
extends QueryAggregation

Returns the top documents ranked by the score of the query.

Field Summary

Fields

Modifier and Type	Field and Description
protected QueryTopHitsAggregationResult	hits
protected java.lang.String	name
protected java.lang.Long	size

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

discriminatorMapping, discriminatorPropertyName, type

Constructor Summary

Constructors

Constructor and Description
QueryTopHitsAggregation()

Method Summary

Methods

Modifier and Type	Method and Description
QueryTopHitsAggregationResult	getHits() Gets the hits.
java.lang.String	getName() Gets the name.
java.lang.Long	getSize() Gets the size.

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

size

protected java.lang.Long size

name

protected java.lang.String name

hits

protected QueryTopHitsAggregationResult hits

Constructor Detail

QueryTopHitsAggregation

public QueryTopHitsAggregation()

Method Detail

getSize

public java.lang.Long getSize()

Gets the size.

The number of documents to return.

Returns:

the size

getName

public java.lang.String getName()

Gets the name.

Identifier specified in the query request of this aggregation.

Returns:

the name

getHits

public QueryTopHitsAggregationResult getHits()

Gets the hits.

Returns:

the hits