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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	baseModelId
protected java.lang.Long	characterCount
protected java.util.Date	completed
protected java.util.Date	created
protected java.lang.Double	detectedLanguageConfidence
protected java.lang.String	documentId
protected java.lang.String	filename
protected java.lang.String	modelId
protected java.lang.String	source
protected java.lang.String	status
protected java.lang.String	target
protected java.lang.Long	wordCount

Constructor Summary

Constructors

Constructor and Description
DocumentStatus()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBaseModelId() Gets the baseModelId.
java.lang.Long	getCharacterCount() Gets the characterCount.
java.util.Date	getCompleted() Gets the completed.
java.util.Date	getCreated() Gets the created.
java.lang.Double	getDetectedLanguageConfidence() Gets the detectedLanguageConfidence.
java.lang.String	getDocumentId() Gets the documentId.
java.lang.String	getFilename() Gets the filename.
java.lang.String	getModelId() Gets the modelId.
java.lang.String	getSource() Gets the source.
java.lang.String	getStatus() Gets the status.
java.lang.String	getTarget() Gets the target.
java.lang.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

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

Field Detail

documentId

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

filename

protected java.lang.String filename

status

protected java.lang.String status

modelId

@SerializedName(value="model_id")
protected java.lang.String modelId

baseModelId

@SerializedName(value="base_model_id")
protected java.lang.String baseModelId

source

protected java.lang.String source

detectedLanguageConfidence

@SerializedName(value="detected_language_confidence")
protected java.lang.Double detectedLanguageConfidence

target

protected java.lang.String target

created

protected java.util.Date created

completed

protected java.util.Date completed

wordCount

@SerializedName(value="word_count")
protected java.lang.Long wordCount

characterCount

@SerializedName(value="character_count")
protected java.lang.Long characterCount

Constructor Detail

DocumentStatus

public DocumentStatus()

Method Detail

getDocumentId

public java.lang.String getDocumentId()

Gets the documentId.

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

Returns:

the documentId

getFilename

public java.lang.String getFilename()

Gets the filename.

filename from the submission (if it was missing in the multipart-form, 'noname.' is used.

Returns:

the filename

getStatus

public java.lang.String getStatus()

Gets the status.

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

Returns:

the status

getModelId

public java.lang.String getModelId()

Gets the modelId.

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

Returns:

the modelId

getBaseModelId

public java.lang.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 java.lang.String getSource()

Gets the source.

Translation source language code.

Returns:

the source

getDetectedLanguageConfidence

public java.lang.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 java.lang.String getTarget()

Gets the target.

Translation target language code.

Returns:

the target

getCreated

public java.util.Date getCreated()

Gets the created.

The time when the document was submitted.

Returns:

the created

getCompleted

public java.util.Date getCompleted()

Gets the completed.

The time when the translation completed.

Returns:

the completed

getWordCount

public java.lang.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 java.lang.Long getCharacterCount()

Gets the characterCount.

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

Returns:

the characterCount