com.ibm.watson.discovery.v2.model

Class DocumentDetails

java.lang.Object

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

com.ibm.watson.discovery.v2.model.DocumentDetails

All Implemented Interfaces:

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

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

Information about a document.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DocumentDetails.Status The status of the ingestion of the document.

Constructor Summary

Constructors

Constructor and Description
DocumentDetails()

Method Summary

Modifier and Type	Method and Description
DocumentDetailsChildren	getChildren() Gets the children.
Date	getCreated() Gets the created.
String	getDocumentId() Gets the documentId.
String	getFilename() Gets the filename.
String	getFileType() Gets the fileType.
List<Notice>	getNotices() Gets the notices.
String	getSha256() Gets the sha256.
String	getStatus() Gets the status.
Date	getUpdated() Gets the updated.

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

DocumentDetails

public DocumentDetails()

Method Detail

getDocumentId

public String getDocumentId()

Gets the documentId.

The unique identifier of the document.

Returns:

the documentId

getCreated

public Date getCreated()

Gets the created.

Date and time that the document is added to the collection. For a child document, the date and time when the process that generates the child document runs. The date-time format is `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.

Returns:

the created

getUpdated

public Date getUpdated()

Gets the updated.

Date and time that the document is finished being processed and is indexed. This date changes whenever the document is reprocessed, including for enrichment changes. The date-time format is `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.

Returns:

the updated

getStatus

public String getStatus()

Gets the status.

The status of the ingestion of the document. The possible values are:

* `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.

Returns:

the status

getNotices

public List<Notice> getNotices()

Gets the notices.

Array of JSON objects for notices, meaning warning or error messages, that are produced by the document ingestion process. The array does not include notices that are produced for child documents that are generated when a document is processed.

Returns:

the notices

getChildren

public DocumentDetailsChildren getChildren()

Gets the children.

Information about the child documents that are generated from a single document during ingestion or other processing.

Returns:

the children

getFilename

public String getFilename()

Gets the filename.

Name of the original source file (if available).

Returns:

the filename

getFileType

public String getFileType()

Gets the fileType.

The type of the original source file, such as `csv`, `excel`, `html`, `json`, `pdf`, `text`, `word`, and so on.

Returns:

the fileType

getSha256

public String getSha256()

Gets the sha256.

The SHA-256 hash of the original source file. The hash is formatted as a hexadecimal string.

Returns:

the sha256