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 and Description
static interface	DocumentStatus.FileType The type of the original source file.
static interface	DocumentStatus.Status Status of the document in the ingestion process.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	configurationId
protected java.lang.String	documentId
protected java.lang.String	filename
protected java.lang.String	fileType
protected java.util.List<Notice>	notices
protected java.lang.String	sha1
protected java.lang.String	status
protected java.lang.String	statusDescription

Constructor Summary

Constructors

Constructor and Description
DocumentStatus()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getConfigurationId() Gets the configurationId.
java.lang.String	getDocumentId() Gets the documentId.
java.lang.String	getFilename() Gets the filename.
java.lang.String	getFileType() Gets the fileType.
java.util.List<Notice>	getNotices() Gets the notices.
java.lang.String	getSha1() Gets the sha1.
java.lang.String	getStatus() Gets the status.
java.lang.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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

documentId

@SerializedName(value="document_id")
protected java.lang.String documentId

configurationId

@SerializedName(value="configuration_id")
protected java.lang.String configurationId

status

protected java.lang.String status

statusDescription

@SerializedName(value="status_description")
protected java.lang.String statusDescription

filename

protected java.lang.String filename

fileType

@SerializedName(value="file_type")
protected java.lang.String fileType

sha1

protected java.lang.String sha1

notices

protected java.util.List<Notice> notices

Constructor Detail

DocumentStatus

public DocumentStatus()

Method Detail

getDocumentId

public java.lang.String getDocumentId()

Gets the documentId.

The unique identifier of the document.

Returns:

the documentId

getConfigurationId

public java.lang.String getConfigurationId()

Gets the configurationId.

The unique identifier for the configuration.

Returns:

the configurationId

getStatus

public java.lang.String getStatus()

Gets the status.

Status of the document in the ingestion process.

Returns:

the status

getStatusDescription

public java.lang.String getStatusDescription()

Gets the statusDescription.

Description of the document status.

Returns:

the statusDescription

getFilename

public java.lang.String getFilename()

Gets the filename.

Name of the original source file (if available).

Returns:

the filename

getFileType

public java.lang.String getFileType()

Gets the fileType.

The type of the original source file.

Returns:

the fileType

getSha1

public java.lang.String getSha1()

Gets the sha1.

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

Returns:

the sha1

getNotices

public java.util.List<Notice> getNotices()

Gets the notices.

Array of notices produced by the document-ingestion process.

Returns:

the notices