com.ibm.watson.discovery.v2.model

Class ListDocumentsOptions

java.lang.Object

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

com.ibm.watson.discovery.v2.model.ListDocumentsOptions

All Implemented Interfaces:

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

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

The listDocuments options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListDocumentsOptions.Builder Builder.

Method Summary

Modifier and Type	Method and Description
String	collectionId() Gets the collectionId.
Long	count() Gets the count.
Boolean	hasNotices() Gets the hasNotices.
Boolean	isParent() Gets the isParent.
ListDocumentsOptions.Builder	newBuilder() New builder.
String	parentDocumentId() Gets the parentDocumentId.
String	projectId() Gets the projectId.
String	sha256() Gets the sha256.
String	status() Gets the status.

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

newBuilder

public ListDocumentsOptions.Builder newBuilder()

New builder.

Returns:

a ListDocumentsOptions builder

projectId

public String projectId()

Gets the projectId.

The Universally Unique Identifier (UUID) of the project. This information can be found from the *Integrate and Deploy* page in Discovery.

Returns:

the projectId

collectionId

public String collectionId()

Gets the collectionId.

The Universally Unique Identifier (UUID) of the collection.

Returns:

the collectionId

count

public Long count()

Gets the count.

The maximum number of documents to return. Up to 1,000 documents are returned by default. The maximum number allowed is 10,000.

Returns:

the count

status

public String status()

Gets the status.

Filters the documents to include only documents with the specified ingestion status. The options include:

* `available`: Ingestion is finished and the document is indexed.

* `failed`: Ingestion is finished, but the document is not indexed because of an error.

* `pending`: The document is uploaded, but the ingestion process is not started.

* `processing`: Ingestion is in progress.

You can specify one status value or add a comma-separated list of more than one status value. For example, `available,failed`.

Returns:

the status

hasNotices

public Boolean hasNotices()

Gets the hasNotices.

If set to `true`, only documents that have notices, meaning documents for which warnings or errors were generated during the ingestion, are returned. If set to `false`, only documents that don't have notices are returned. If unspecified, no filter based on notices is applied.

Notice details are not available in the result, but you can use the [Query collection notices](#querycollectionnotices) method to find details by adding the parameter `query=notices.document_id:{document-id}`.

Returns:

the hasNotices

isParent

public Boolean isParent()

Gets the isParent.

If set to `true`, only parent documents, meaning documents that were split during the ingestion process and resulted in two or more child documents, are returned. If set to `false`, only child documents are returned. If unspecified, no filter based on the parent or child relationship is applied.

CSV files, for example, are split into separate documents per line and JSON files are split into separate documents per object.

Returns:

the isParent

parentDocumentId

public String parentDocumentId()

Gets the parentDocumentId.

Filters the documents to include only child documents that were generated when the specified parent document was processed.

Returns:

the parentDocumentId

sha256

public String sha256()

Gets the sha256.

Filters the documents to include only documents with the specified SHA-256 hash. Format the hash as a hexadecimal string.

Returns:

the sha256