com.google.api.services.translate.v3.model

Class TranslateDocumentRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.translate.v3.model.TranslateDocumentRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class TranslateDocumentRequest
extends GenericJson

A document translation request.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Translation API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
TranslateDocumentRequest()

Method Summary

Modifier and Type	Method and Description
TranslateDocumentRequest	clone()
DocumentInputConfig	getDocumentInputConfig() Required.
DocumentOutputConfig	getDocumentOutputConfig() Optional.
TranslateTextGlossaryConfig	getGlossaryConfig() Optional.
Map<String,String>	getLabels() Optional.
String	getModel() Optional.
String	getSourceLanguageCode() Optional.
String	getTargetLanguageCode() Required.
TranslateDocumentRequest	set(String fieldName, Object value)
TranslateDocumentRequest	setDocumentInputConfig(DocumentInputConfig documentInputConfig) Required.
TranslateDocumentRequest	setDocumentOutputConfig(DocumentOutputConfig documentOutputConfig) Optional.
TranslateDocumentRequest	setGlossaryConfig(TranslateTextGlossaryConfig glossaryConfig) Optional.
TranslateDocumentRequest	setLabels(Map<String,String> labels) Optional.
TranslateDocumentRequest	setModel(String model) Optional.
TranslateDocumentRequest	setSourceLanguageCode(String sourceLanguageCode) Optional.
TranslateDocumentRequest	setTargetLanguageCode(String targetLanguageCode) Required.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

TranslateDocumentRequest

public TranslateDocumentRequest()

Method Detail

getDocumentInputConfig

public DocumentInputConfig getDocumentInputConfig()

Required. Input configurations.

Returns:

value or null for none

setDocumentInputConfig

public TranslateDocumentRequest setDocumentInputConfig(DocumentInputConfig documentInputConfig)

Required. Input configurations.

Parameters:

documentInputConfig - documentInputConfig or null for none

getDocumentOutputConfig

public DocumentOutputConfig getDocumentOutputConfig()

Optional. Output configurations. Defines if the output file should be stored within Cloud Storage as well as the desired output format. If not provided the translated file will only be returned through a byte-stream and its output mime type will be the same as the input file's mime type.

Returns:

value or null for none

setDocumentOutputConfig

public TranslateDocumentRequest setDocumentOutputConfig(DocumentOutputConfig documentOutputConfig)

Optional. Output configurations. Defines if the output file should be stored within Cloud Storage as well as the desired output format. If not provided the translated file will only be returned through a byte-stream and its output mime type will be the same as the input file's mime type.

Parameters:

documentOutputConfig - documentOutputConfig or null for none

getGlossaryConfig

public TranslateTextGlossaryConfig getGlossaryConfig()

Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.

Returns:

value or null for none

setGlossaryConfig

public TranslateDocumentRequest setGlossaryConfig(TranslateTextGlossaryConfig glossaryConfig)

Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.

Parameters:

glossaryConfig - glossaryConfig or null for none

getLabels

public Map<String,String> getLabels()

Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. See https://cloud.google.com/translate/docs/advanced/labels for more information.

Returns:

value or null for none

setLabels

public TranslateDocumentRequest setLabels(Map<String,String> labels)

Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. See https://cloud.google.com/translate/docs/advanced/labels for more information.

Parameters:

labels - labels or null for none

getModel

public String getModel()

Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models /{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location- id}/models/general/nmt`, If not provided, the default Google model (NMT) will be used for translation.

Returns:

value or null for none

setModel

public TranslateDocumentRequest setModel(String model)

Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models /{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location- id}/models/general/nmt`, If not provided, the default Google model (NMT) will be used for translation.

Parameters:

model - model or null for none

getSourceLanguageCode

public String getSourceLanguageCode()

Optional. The BCP-47 language code of the input document if known, for example, "en-US" or "sr- Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response. Source language must be specified if the request contains a glossary or a custom model.

Returns:

value or null for none

setSourceLanguageCode

public TranslateDocumentRequest setSourceLanguageCode(String sourceLanguageCode)

Optional. The BCP-47 language code of the input document if known, for example, "en-US" or "sr- Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response. Source language must be specified if the request contains a glossary or a custom model.

Parameters:

sourceLanguageCode - sourceLanguageCode or null for none

getTargetLanguageCode

public String getTargetLanguageCode()

Required. The BCP-47 language code to use for translation of the input document, set to one of the language codes listed in Language Support.

Returns:

value or null for none

setTargetLanguageCode

public TranslateDocumentRequest setTargetLanguageCode(String targetLanguageCode)

Required. The BCP-47 language code to use for translation of the input document, set to one of the language codes listed in Language Support.

Parameters:

targetLanguageCode - targetLanguageCode or null for none

set

public TranslateDocumentRequest set(String fieldName,
                                    Object value)

Overrides:

set in class GenericJson

clone

public TranslateDocumentRequest clone()

Overrides:

clone in class GenericJson