com.ibm.watson.discovery.v2.model

Class ListDocumentsResponse

java.lang.Object

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

com.ibm.watson.discovery.v2.model.ListDocumentsResponse

All Implemented Interfaces:

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

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

Response object that contains an array of documents.

Constructor Summary

Constructors

Constructor and Description
ListDocumentsResponse()

Method Summary

Modifier and Type	Method and Description
List<DocumentDetails>	getDocuments() Gets the documents.
Long	getMatchingResults() Gets the matchingResults.

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 Detail

ListDocumentsResponse

public ListDocumentsResponse()

Method Detail

getMatchingResults

public Long getMatchingResults()

Gets the matchingResults.

The number of matching results for the document query.

Returns:

the matchingResults

getDocuments

public List<DocumentDetails> getDocuments()

Gets the documents.

An array that lists the documents in a collection. Only the document ID of each document is returned in the list. You can use the [Get document](#getdocument) method to get more information about an individual document.

Returns:

the documents