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

Class BatchTranslateDocumentRequest

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.BatchTranslateDocumentRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class BatchTranslateDocumentRequest
extends GenericJson

The BatchTranslateDocument 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
BatchTranslateDocumentRequest()

Method Summary

Modifier and Type	Method and Description
BatchTranslateDocumentRequest	clone()
Map<String,String>	getFormatConversions() Optional.
Map<String,TranslateTextGlossaryConfig>	getGlossaries() Optional.
List<BatchDocumentInputConfig>	getInputConfigs() Required.
Map<String,String>	getModels() Optional.
BatchDocumentOutputConfig	getOutputConfig() Required.
String	getSourceLanguageCode() Required.
List<String>	getTargetLanguageCodes() Required.
BatchTranslateDocumentRequest	set(String fieldName, Object value)
BatchTranslateDocumentRequest	setFormatConversions(Map<String,String> formatConversions) Optional.
BatchTranslateDocumentRequest	setGlossaries(Map<String,TranslateTextGlossaryConfig> glossaries) Optional.
BatchTranslateDocumentRequest	setInputConfigs(List<BatchDocumentInputConfig> inputConfigs) Required.
BatchTranslateDocumentRequest	setModels(Map<String,String> models) Optional.
BatchTranslateDocumentRequest	setOutputConfig(BatchDocumentOutputConfig outputConfig) Required.
BatchTranslateDocumentRequest	setSourceLanguageCode(String sourceLanguageCode) Required.
BatchTranslateDocumentRequest	setTargetLanguageCodes(List<String> targetLanguageCodes) 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

BatchTranslateDocumentRequest

public BatchTranslateDocumentRequest()

Method Detail

getFormatConversions

public Map<String,String> getFormatConversions()

Optional.

Returns:

value or null for none

setFormatConversions

public BatchTranslateDocumentRequest setFormatConversions(Map<String,String> formatConversions)

Optional.

Parameters:

formatConversions - formatConversions or null for none

getGlossaries

public Map<String,TranslateTextGlossaryConfig> getGlossaries()

Optional. Glossaries to be applied. It's keyed by target language code.

Returns:

value or null for none

setGlossaries

public BatchTranslateDocumentRequest setGlossaries(Map<String,TranslateTextGlossaryConfig> glossaries)

Optional. Glossaries to be applied. It's keyed by target language code.

Parameters:

glossaries - glossaries or null for none

getInputConfigs

public List<BatchDocumentInputConfig> getInputConfigs()

Required. Input configurations. The total number of files matched should be <= 100. The total content size to translate should be <= 100M Unicode codepoints. The files must use UTF-8 encoding.

Returns:

value or null for none

setInputConfigs

public BatchTranslateDocumentRequest setInputConfigs(List<BatchDocumentInputConfig> inputConfigs)

Required. Input configurations. The total number of files matched should be <= 100. The total content size to translate should be <= 100M Unicode codepoints. The files must use UTF-8 encoding.

Parameters:

inputConfigs - inputConfigs or null for none

getModels

public Map<String,String> getModels()

Optional. The models to use for translation. Map's key is target language code. Map's value is the model name. Value can be a built-in general model, or an AutoML Translation model. The value 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 the map is empty or a specific model is not requested for a language pair, then default google model (nmt) is used.

Returns:

value or null for none

setModels

public BatchTranslateDocumentRequest setModels(Map<String,String> models)

Optional. The models to use for translation. Map's key is target language code. Map's value is the model name. Value can be a built-in general model, or an AutoML Translation model. The value 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 the map is empty or a specific model is not requested for a language pair, then default google model (nmt) is used.

Parameters:

models - models or null for none

getOutputConfig

public BatchDocumentOutputConfig getOutputConfig()

Required. Output configuration. If 2 input configs match to the same file (that is, same input path), we don't generate output for duplicate inputs.

Returns:

value or null for none

setOutputConfig

public BatchTranslateDocumentRequest setOutputConfig(BatchDocumentOutputConfig outputConfig)

Required. Output configuration. If 2 input configs match to the same file (that is, same input path), we don't generate output for duplicate inputs.

Parameters:

outputConfig - outputConfig or null for none

getSourceLanguageCode

public String getSourceLanguageCode()

Required. 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 (https://cloud.google.com/translate/docs/languages).

Returns:

value or null for none

setSourceLanguageCode

public BatchTranslateDocumentRequest setSourceLanguageCode(String sourceLanguageCode)

Required. 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 (https://cloud.google.com/translate/docs/languages).

Parameters:

sourceLanguageCode - sourceLanguageCode or null for none

getTargetLanguageCodes

public List<String> getTargetLanguageCodes()

Required. The BCP-47 language code to use for translation of the input document. Specify up to 10 language codes here.

Returns:

value or null for none

setTargetLanguageCodes

public BatchTranslateDocumentRequest setTargetLanguageCodes(List<String> targetLanguageCodes)

Required. The BCP-47 language code to use for translation of the input document. Specify up to 10 language codes here.

Parameters:

targetLanguageCodes - targetLanguageCodes or null for none

set

public BatchTranslateDocumentRequest set(String fieldName,
                                         Object value)

Overrides:

set in class GenericJson

clone

public BatchTranslateDocumentRequest clone()

Overrides:

clone in class GenericJson