com.ibm.watson.language_translator.v3.model

Class DocumentStatus

java.lang.Object

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

com.ibm.watson.language_translator.v3.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

Document information, including translation status.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DocumentStatus.Status The status of the translation job associated with a submitted document.

Method Summary

Modifier and Type	Method and Description
String	getBaseModelId() Gets the baseModelId.
Long	getCharacterCount() Gets the characterCount.
Date	getCompleted() Gets the completed.
Date	getCreated() Gets the created.
Double	getDetectedLanguageConfidence() Gets the detectedLanguageConfidence.
String	getDocumentId() Gets the documentId.
String	getFilename() Gets the filename.
String	getModelId() Gets the modelId.
String	getSource() Gets the source.
String	getStatus() Gets the status.
String	getTarget() Gets the target.
Long	getWordCount() Gets the wordCount.

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

getDocumentId

public String getDocumentId()

Gets the documentId.

System generated ID identifying a document being translated using one specific translation model.

Returns:

the documentId

getFilename

public String getFilename()

Gets the filename.

filename from the submission (if it was missing in the multipart-form, 'noname.<ext matching content type>' is used.

Returns:

the filename

getStatus

public String getStatus()

Gets the status.

The status of the translation job associated with a submitted document.

Returns:

the status

getModelId

public String getModelId()

Gets the modelId.

A globally unique string that identifies the underlying model that is used for translation.

Returns:

the modelId

getBaseModelId

public String getBaseModelId()

Gets the baseModelId.

Model ID of the base model that was used to customize the model. If the model is not a custom model, this will be absent or an empty string.

Returns:

the baseModelId

getSource

public String getSource()

Gets the source.

Translation source language code.

Returns:

the source

getDetectedLanguageConfidence

public Double getDetectedLanguageConfidence()

Gets the detectedLanguageConfidence.

A score between 0 and 1 indicating the confidence of source language detection. A higher value indicates greater confidence. This is returned only when the service automatically detects the source language.

Returns:

the detectedLanguageConfidence

getTarget

public String getTarget()

Gets the target.

Translation target language code.

Returns:

the target

getCreated

public Date getCreated()

Gets the created.

The time when the document was submitted.

Returns:

the created

getCompleted

public Date getCompleted()

Gets the completed.

The time when the translation completed.

Returns:

the completed

getWordCount

public Long getWordCount()

Gets the wordCount.

An estimate of the number of words in the source document. Returned only if `status` is `available`.

Returns:

the wordCount

getCharacterCount

public Long getCharacterCount()

Gets the characterCount.

The number of characters in the source document, present only if status=available.

Returns:

the characterCount