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

Class TranslateTextRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class TranslateTextRequest
extends GenericJson

The request message for synchronous translation.

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
TranslateTextRequest()

Method Summary

Modifier and Type	Method and Description
TranslateTextRequest	clone()
List<String>	getContents() Required.
TranslateTextGlossaryConfig	getGlossaryConfig() Optional.
Map<String,String>	getLabels() Optional.
String	getMimeType() Optional.
String	getModel() Optional.
String	getSourceLanguageCode() Optional.
String	getTargetLanguageCode() Required.
TranslateTextRequest	set(String fieldName, Object value)
TranslateTextRequest	setContents(List<String> contents) Required.
TranslateTextRequest	setGlossaryConfig(TranslateTextGlossaryConfig glossaryConfig) Optional.
TranslateTextRequest	setLabels(Map<String,String> labels) Optional.
TranslateTextRequest	setMimeType(String mimeType) Optional.
TranslateTextRequest	setModel(String model) Optional.
TranslateTextRequest	setSourceLanguageCode(String sourceLanguageCode) Optional.
TranslateTextRequest	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

TranslateTextRequest

public TranslateTextRequest()

Method Detail

getContents

public List<String> getContents()

Required. The content of the input in string format. We recommend the total content be less than 30k codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

Returns:

value or null for none

setContents

public TranslateTextRequest setContents(List<String> contents)

Required. The content of the input in string format. We recommend the total content be less than 30k codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

Parameters:

contents - contents 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 TranslateTextRequest 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 TranslateTextRequest 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

getMimeType

public String getMimeType()

Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".

Returns:

value or null for none

setMimeType

public TranslateTextRequest setMimeType(String mimeType)

Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".

Parameters:

mimeType - mimeType 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`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used

Returns:

value or null for none

setModel

public TranslateTextRequest 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`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used

Parameters:

model - model or null for none

getSourceLanguageCode

public String getSourceLanguageCode()

Optional. The BCP-47 language code of the input text 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.

Returns:

value or null for none

setSourceLanguageCode

public TranslateTextRequest setSourceLanguageCode(String sourceLanguageCode)

Optional. The BCP-47 language code of the input text 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.

Parameters:

sourceLanguageCode - sourceLanguageCode or null for none

getTargetLanguageCode

public String getTargetLanguageCode()

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

Returns:

value or null for none

setTargetLanguageCode

public TranslateTextRequest setTargetLanguageCode(String targetLanguageCode)

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

Parameters:

targetLanguageCode - targetLanguageCode or null for none

set

public TranslateTextRequest set(String fieldName,
                                Object value)

Overrides:

set in class GenericJson

clone

public TranslateTextRequest clone()

Overrides:

clone in class GenericJson