Reference documentation and code samples for the Cloud Translation V3 Client class BatchTranslateTextRequest.
The batch translation request.
Generated from protobuf messagegoogle.cloud.translation.v3.BatchTranslateTextRequest
Namespace
Google \ Cloud \ Translate \ V3
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. Location to make a call. Must refer to a caller's project. Format:projects/{project-number-or-id}/locations/{location-id}. Thegloballocation is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.
↳ source_language_code
string
Required. Source language code. Supported language codes are listed inLanguage Support.
↳ target_language_codes
array
Required. Specify up to 10 language codes here. Supported language codes are listed inLanguage Support.
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.
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.
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. Seehttps://cloud.google.com/translate/docs/advanced/labelsfor more information.
getParent
Required. Location to make a call. Must refer to a caller's project.
Format:projects/{project-number-or-id}/locations/{location-id}.
Thegloballocation is not supported for batch translation.
Only AutoML Translation models or glossaries within the same region (have
the same location-id) can be used, otherwise an INVALID_ARGUMENT (400)
error is returned.
Returns
Type
Description
string
setParent
Required. Location to make a call. Must refer to a caller's project.
Format:projects/{project-number-or-id}/locations/{location-id}.
Thegloballocation is not supported for batch translation.
Only AutoML Translation models or glossaries within the same region (have
the same location-id) can be used, otherwise an INVALID_ARGUMENT (400)
error is returned.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getSourceLanguageCode
Required. Source language code. Supported language codes are listed inLanguage
Support.
Returns
Type
Description
string
setSourceLanguageCode
Required. Source language code. Supported language codes are listed inLanguage
Support.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getTargetLanguageCodes
Required. Specify up to 10 language codes here. Supported language codes
are listed inLanguage
Support.
Required. Specify up to 10 language codes here. Supported language codes
are listed inLanguage
Support.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
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.
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.
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.
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.
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.
Seehttps://cloud.google.com/translate/docs/advanced/labelsfor more
information.
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.
Seehttps://cloud.google.com/translate/docs/advanced/labelsfor more
information.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Translation V3 Client - Class BatchTranslateTextRequest (2.0.3)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.3 (latest)](/php/docs/reference/cloud-translate/latest/V3.BatchTranslateTextRequest)\n- [2.0.2](/php/docs/reference/cloud-translate/2.0.2/V3.BatchTranslateTextRequest)\n- [1.21.0](/php/docs/reference/cloud-translate/1.21.0/V3.BatchTranslateTextRequest)\n- [1.20.2](/php/docs/reference/cloud-translate/1.20.2/V3.BatchTranslateTextRequest)\n- [1.19.0](/php/docs/reference/cloud-translate/1.19.0/V3.BatchTranslateTextRequest)\n- [1.18.1](/php/docs/reference/cloud-translate/1.18.1/V3.BatchTranslateTextRequest)\n- [1.17.7](/php/docs/reference/cloud-translate/1.17.7/V3.BatchTranslateTextRequest)\n- [1.16.0](/php/docs/reference/cloud-translate/1.16.0/V3.BatchTranslateTextRequest)\n- [1.15.4](/php/docs/reference/cloud-translate/1.15.4/V3.BatchTranslateTextRequest)\n- [1.14.3](/php/docs/reference/cloud-translate/1.14.3/V3.BatchTranslateTextRequest)\n- [1.13.3](/php/docs/reference/cloud-translate/1.13.3/V3.BatchTranslateTextRequest)\n- [1.12.12](/php/docs/reference/cloud-translate/1.12.12/V3.BatchTranslateTextRequest) \nReference documentation and code samples for the Cloud Translation V3 Client class BatchTranslateTextRequest.\n\nThe batch translation request.\n\nGenerated from protobuf message `google.cloud.translation.v3.BatchTranslateTextRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Translate \\\\ V3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. Location to make a call. Must refer to a caller's project.\n\nFormat: `projects/{project-number-or-id}/locations/{location-id}`.\nThe `global` location is not supported for batch translation.\nOnly AutoML Translation models or glossaries within the same region (have\nthe same location-id) can be used, otherwise an INVALID_ARGUMENT (400)\nerror is returned.\n\n### setParent\n\nRequired. Location to make a call. Must refer to a caller's project.\n\nFormat: `projects/{project-number-or-id}/locations/{location-id}`.\nThe `global` location is not supported for batch translation.\nOnly AutoML Translation models or glossaries within the same region (have\nthe same location-id) can be used, otherwise an INVALID_ARGUMENT (400)\nerror is returned.\n\n### getSourceLanguageCode\n\nRequired. Source language code. Supported language codes are listed in\n[Language\nSupport](https://cloud.google.com/translate/docs/languages).\n\n### setSourceLanguageCode\n\nRequired. Source language code. Supported language codes are listed in\n[Language\nSupport](https://cloud.google.com/translate/docs/languages).\n\n### getTargetLanguageCodes\n\nRequired. Specify up to 10 language codes here. Supported language codes\nare listed in [Language\nSupport](https://cloud.google.com/translate/docs/languages).\n\n### setTargetLanguageCodes\n\nRequired. Specify up to 10 language codes here. Supported language codes\nare listed in [Language\nSupport](https://cloud.google.com/translate/docs/languages).\n\n### getModels\n\nOptional. The models to use for translation. Map's key is target language\ncode. Map's value is model name. Value can be a built-in general model,\nor an AutoML Translation model.\n\nThe value format depends on model type:\n\n- AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`\n- 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.\n\n### setModels\n\nOptional. The models to use for translation. Map's key is target language\ncode. Map's value is model name. Value can be a built-in general model,\nor an AutoML Translation model.\n\nThe value format depends on model type:\n\n- AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`\n- 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.\n\n### getInputConfigs\n\nRequired. Input configurations.\n\nThe total number of files matched should be \\\u003c= 100.\nThe total content size should be \\\u003c= 100M Unicode codepoints.\nThe files must use UTF-8 encoding.\n\n### setInputConfigs\n\nRequired. Input configurations.\n\nThe total number of files matched should be \\\u003c= 100.\nThe total content size should be \\\u003c= 100M Unicode codepoints.\nThe files must use UTF-8 encoding.\n\n### getOutputConfig\n\nRequired. Output configuration.\n\nIf 2 input configs match to the same file (that is, same input path),\nwe don't generate output for duplicate inputs.\n\n### hasOutputConfig\n\n### clearOutputConfig\n\n### setOutputConfig\n\nRequired. Output configuration.\n\nIf 2 input configs match to the same file (that is, same input path),\nwe don't generate output for duplicate inputs.\n\n### getGlossaries\n\nOptional. Glossaries to be applied for translation.\n\nIt's keyed by target language code.\n\n### setGlossaries\n\nOptional. Glossaries to be applied for translation.\n\nIt's keyed by target language code.\n\n### getLabels\n\nOptional. The labels with user-defined metadata for the request.\n\nLabel keys and values can be no longer than 63 characters\n(Unicode codepoints), can only contain lowercase letters, numeric\ncharacters, underscores and dashes. International characters are allowed.\nLabel values are optional. Label keys must start with a letter.\nSee \u003chttps://cloud.google.com/translate/docs/advanced/labels\u003e for more\ninformation.\n\n### setLabels\n\nOptional. The labels with user-defined metadata for the request.\n\nLabel keys and values can be no longer than 63 characters\n(Unicode codepoints), can only contain lowercase letters, numeric\ncharacters, underscores and dashes. International characters are allowed.\nLabel values are optional. Label keys must start with a letter.\nSee \u003chttps://cloud.google.com/translate/docs/advanced/labels\u003e for more\ninformation."]]
