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

Class BatchTranslateTextRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class BatchTranslateTextRequest
extends GenericJson

The batch 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
BatchTranslateTextRequest()

Method Summary

Modifier and Type	Method and Description
BatchTranslateTextRequest	clone()
Map<String,TranslateTextGlossaryConfig>	getGlossaries() Optional.
List<InputConfig>	getInputConfigs() Required.
Map<String,String>	getLabels() Optional.
Map<String,String>	getModels() Optional.
OutputConfig	getOutputConfig() Required.
String	getSourceLanguageCode() Required.
List<String>	getTargetLanguageCodes() Required.
BatchTranslateTextRequest	set(String fieldName, Object value)
BatchTranslateTextRequest	setGlossaries(Map<String,TranslateTextGlossaryConfig> glossaries) Optional.
BatchTranslateTextRequest	setInputConfigs(List<InputConfig> inputConfigs) Required.
BatchTranslateTextRequest	setLabels(Map<String,String> labels) Optional.
BatchTranslateTextRequest	setModels(Map<String,String> models) Optional.
BatchTranslateTextRequest	setOutputConfig(OutputConfig outputConfig) Required.
BatchTranslateTextRequest	setSourceLanguageCode(String sourceLanguageCode) Required.
BatchTranslateTextRequest	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

BatchTranslateTextRequest

public BatchTranslateTextRequest()

Method Detail

getGlossaries

public Map<String,TranslateTextGlossaryConfig> getGlossaries()

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

Returns:

value or null for none

setGlossaries

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

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

Parameters:

glossaries - glossaries or null for none

getInputConfigs

public List<InputConfig> getInputConfigs()

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

Returns:

value or null for none

setInputConfigs

public BatchTranslateTextRequest setInputConfigs(List<InputConfig> inputConfigs)

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

Parameters:

inputConfigs - inputConfigs 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 BatchTranslateTextRequest 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

getModels

public Map<String,String> getModels()

Optional. The models to use for translation. Map's key is target language code. Map's value is 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 BatchTranslateTextRequest setModels(Map<String,String> models)

Optional. The models to use for translation. Map's key is target language code. Map's value is 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 OutputConfig 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 BatchTranslateTextRequest setOutputConfig(OutputConfig 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. Source language code.

Returns:

value or null for none

setSourceLanguageCode

public BatchTranslateTextRequest setSourceLanguageCode(String sourceLanguageCode)

Required. Source language code.

Parameters:

sourceLanguageCode - sourceLanguageCode or null for none

getTargetLanguageCodes

public List<String> getTargetLanguageCodes()

Required. Specify up to 10 language codes here.

Returns:

value or null for none

setTargetLanguageCodes

public BatchTranslateTextRequest setTargetLanguageCodes(List<String> targetLanguageCodes)

Required. Specify up to 10 language codes here.

Parameters:

targetLanguageCodes - targetLanguageCodes or null for none

set

public BatchTranslateTextRequest set(String fieldName,
                                     Object value)

Overrides:

set in class GenericJson

clone

public BatchTranslateTextRequest clone()

Overrides:

clone in class GenericJson