Package com.ibm.watson.discovery.v1.model

Class DocumentStatus

java.lang.Object

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

com.ibm.watson.discovery.v1.model.DocumentStatus

All Implemented Interfaces:

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

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

Status information about a submitted document.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentStatus.FileType	The type of the original source file.
static interface	DocumentStatus.Status	Status of the document in the ingestion process.

Constructor Summary

Constructors

Constructor	Description
DocumentStatus()

Method Summary

Modifier and Type	Method	Description
String	getConfigurationId()	Gets the configurationId.
String	getDocumentId()	Gets the documentId.
String	getFilename()	Gets the filename.
String	getFileType()	Gets the fileType.
List<Notice>	getNotices()	Gets the notices.
String	getSha1()	Gets the sha1.
String	getStatus()	Gets the status.
String	getStatusDescription()	Gets the statusDescription.

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 Details

DocumentStatus

public DocumentStatus()

Method Details

getDocumentId

public String getDocumentId()

Gets the documentId.

The unique identifier of the document.

Returns:

the documentId

getConfigurationId

public String getConfigurationId()

Gets the configurationId.

The unique identifier for the configuration.

Returns:

the configurationId

getStatus

public String getStatus()

Gets the status.

Status of the document in the ingestion process.

Returns:

the status

getStatusDescription

public String getStatusDescription()

Gets the statusDescription.

Description of the document status.

Returns:

the statusDescription

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.

Returns:

the fileType

getSha1

public String getSha1()

Gets the sha1.

The SHA-1 hash of the original source file (formatted as a hexadecimal string).

Returns:

the sha1

getNotices

public List<Notice> getNotices()

Gets the notices.

Array of notices produced by the document-ingestion process.

Returns:

the notices