com.ibm.watson.language_translator.v3.model

Class TranslateDocumentOptions

java.lang.Object

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

com.ibm.watson.language_translator.v3.model.TranslateDocumentOptions

All Implemented Interfaces:

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

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

The translateDocument options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TranslateDocumentOptions.Builder Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	documentId
protected java.io.InputStream	file
protected java.lang.String	fileContentType
protected java.lang.String	filename
protected java.lang.String	modelId
protected java.lang.String	source
protected java.lang.String	target

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TranslateDocumentOptions(TranslateDocumentOptions.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	documentId() Gets the documentId.
java.io.InputStream	file() Gets the file.
java.lang.String	fileContentType() Gets the fileContentType.
java.lang.String	filename() Gets the filename.
java.lang.String	modelId() Gets the modelId.
TranslateDocumentOptions.Builder	newBuilder() New builder.
java.lang.String	source() Gets the source.
java.lang.String	target() Gets the target.

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

file

protected java.io.InputStream file

filename

protected java.lang.String filename

fileContentType

protected java.lang.String fileContentType

modelId

protected java.lang.String modelId

source

protected java.lang.String source

target

protected java.lang.String target

documentId

protected java.lang.String documentId

Constructor Detail

TranslateDocumentOptions

protected TranslateDocumentOptions(TranslateDocumentOptions.Builder builder)

Method Detail

newBuilder

public TranslateDocumentOptions.Builder newBuilder()

New builder.

Returns:

a TranslateDocumentOptions builder

file

public java.io.InputStream file()

Gets the file.

The contents of the source file to translate.

[Supported file types](https://cloud.ibm.com/docs/language-translator?topic=language-translator-document-translator-tutorial#supported-file-formats)

Maximum file size: **20 MB**.

Returns:

the file

filename

public java.lang.String filename()

Gets the filename.

The filename for file.

Returns:

the filename

fileContentType

public java.lang.String fileContentType()

Gets the fileContentType.

The content type of file. Values for this parameter can be obtained from the HttpMediaType class.

Returns:

the fileContentType

modelId

public java.lang.String modelId()

Gets the modelId.

The model to use for translation. For example, `en-de` selects the IBM provided base model for English to German translation. A model ID overrides the source and target parameters and is required if you use a custom model. If no model ID is specified, you must specify a target language.

Returns:

the modelId

source

public java.lang.String source()

Gets the source.

Language code that specifies the language of the source document.

Returns:

the source

target

public java.lang.String target()

Gets the target.

Language code that specifies the target language for translation. Required if model ID is not specified.

Returns:

the target

documentId

public java.lang.String documentId()

Gets the documentId.

To use a previously submitted document as the source for a new translation, enter the `document_id` of the document.

Returns:

the documentId