public class ListDocumentsOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Modifier and Type | Class and Description |
---|---|
static class |
ListDocumentsOptions.Builder
Builder.
|
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.
|
public ListDocumentsOptions.Builder newBuilder()
public String projectId()
The ID of the project. This information can be found from the *Integrate and Deploy* page in Discovery.
public String collectionId()
The ID of the collection.
public Long count()
The maximum number of documents to return. Up to 1,000 documents are returned by default. The maximum number allowed is 10,000.
public String 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`.
public Boolean 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}`.
public Boolean 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.
public String parentDocumentId()
Filters the documents to include only child documents that were generated when the specified parent document was processed.
public String sha256()
Filters the documents to include only documents with the specified SHA-256 hash. Format the hash as a hexadecimal string.
Copyright © 2023 IBM Cloud. All rights reserved.