- 2.47.0 (latest)
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.5
- 2.2.0
- 2.1.13
public static final class BatchTranslateDocumentRequest.Builder extends GeneratedMessageV3.Builder<BatchTranslateDocumentRequest.Builder> implements BatchTranslateDocumentRequestOrBuilder
The BatchTranslateDocument request.
Protobuf type google.cloud.translation.v3beta1.BatchTranslateDocumentRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BatchTranslateDocumentRequest.BuilderImplements
BatchTranslateDocumentRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addAllInputConfigs(Iterable<? extends BatchDocumentInputConfig> values)
public BatchTranslateDocumentRequest.Builder addAllInputConfigs(Iterable<? extends BatchDocumentInputConfig> values)
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
values | Iterable<? extends com.google.cloud.translate.v3beta1.BatchDocumentInputConfig> |
Type | Description |
BatchTranslateDocumentRequest.Builder |
addAllTargetLanguageCodes(Iterable<String> values)
public BatchTranslateDocumentRequest.Builder addAllTargetLanguageCodes(Iterable<String> values)
Required. The BCP-47 language code to use for translation of the input document. Specify up to 10 language codes here.
repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
values | Iterable<String> The targetLanguageCodes to add. |
Type | Description |
BatchTranslateDocumentRequest.Builder | This builder for chaining. |
addInputConfigs(BatchDocumentInputConfig value)
public BatchTranslateDocumentRequest.Builder addInputConfigs(BatchDocumentInputConfig value)
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
value | BatchDocumentInputConfig |
Type | Description |
BatchTranslateDocumentRequest.Builder |
addInputConfigs(BatchDocumentInputConfig.Builder builderForValue)
public BatchTranslateDocumentRequest.Builder addInputConfigs(BatchDocumentInputConfig.Builder builderForValue)
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
builderForValue | BatchDocumentInputConfig.Builder |
Type | Description |
BatchTranslateDocumentRequest.Builder |
addInputConfigs(int index, BatchDocumentInputConfig value)
public BatchTranslateDocumentRequest.Builder addInputConfigs(int index, BatchDocumentInputConfig value)
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
index | int |
value | BatchDocumentInputConfig |
Type | Description |
BatchTranslateDocumentRequest.Builder |
addInputConfigs(int index, BatchDocumentInputConfig.Builder builderForValue)
public BatchTranslateDocumentRequest.Builder addInputConfigs(int index, BatchDocumentInputConfig.Builder builderForValue)
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
index | int |
builderForValue | BatchDocumentInputConfig.Builder |
Type | Description |
BatchTranslateDocumentRequest.Builder |
addInputConfigsBuilder()
public BatchDocumentInputConfig.Builder addInputConfigsBuilder()
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
BatchDocumentInputConfig.Builder |
addInputConfigsBuilder(int index)
public BatchDocumentInputConfig.Builder addInputConfigsBuilder(int index)
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
index | int |
Type | Description |
BatchDocumentInputConfig.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public BatchTranslateDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
BatchTranslateDocumentRequest.Builder |
addTargetLanguageCodes(String value)
public BatchTranslateDocumentRequest.Builder addTargetLanguageCodes(String value)
Required. The BCP-47 language code to use for translation of the input document. Specify up to 10 language codes here.
repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
value | String The targetLanguageCodes to add. |
Type | Description |
BatchTranslateDocumentRequest.Builder | This builder for chaining. |
addTargetLanguageCodesBytes(ByteString value)
public BatchTranslateDocumentRequest.Builder addTargetLanguageCodesBytes(ByteString value)
Required. The BCP-47 language code to use for translation of the input document. Specify up to 10 language codes here.
repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
value | ByteString The bytes of the targetLanguageCodes to add. |
Type | Description |
BatchTranslateDocumentRequest.Builder | This builder for chaining. |
build()
public BatchTranslateDocumentRequest build()
Type | Description |
BatchTranslateDocumentRequest |
buildPartial()
public BatchTranslateDocumentRequest buildPartial()
Type | Description |
BatchTranslateDocumentRequest |
clear()
public BatchTranslateDocumentRequest.Builder clear()
Type | Description |
BatchTranslateDocumentRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public BatchTranslateDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
BatchTranslateDocumentRequest.Builder |
clearFormatConversions()
public BatchTranslateDocumentRequest.Builder clearFormatConversions()
Type | Description |
BatchTranslateDocumentRequest.Builder |
clearGlossaries()
public BatchTranslateDocumentRequest.Builder clearGlossaries()
Type | Description |
BatchTranslateDocumentRequest.Builder |
clearInputConfigs()
public BatchTranslateDocumentRequest.Builder clearInputConfigs()
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
BatchTranslateDocumentRequest.Builder |
clearModels()
public BatchTranslateDocumentRequest.Builder clearModels()
Type | Description |
BatchTranslateDocumentRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public BatchTranslateDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
BatchTranslateDocumentRequest.Builder |
clearOutputConfig()
public BatchTranslateDocumentRequest.Builder clearOutputConfig()
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.
.google.cloud.translation.v3beta1.BatchDocumentOutputConfig output_config = 5 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
BatchTranslateDocumentRequest.Builder |
clearParent()
public BatchTranslateDocumentRequest.Builder clearParent()
Required. Location to make a regional call.
Format: projects/{project-number-or-id}/locations/{location-id}
.
The global
location 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.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Type | Description |
BatchTranslateDocumentRequest.Builder | This builder for chaining. |
clearSourceLanguageCode()
public BatchTranslateDocumentRequest.Builder clearSourceLanguageCode()
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).
string source_language_code = 2 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
BatchTranslateDocumentRequest.Builder | This builder for chaining. |
clearTargetLanguageCodes()
public BatchTranslateDocumentRequest.Builder clearTargetLanguageCodes()
Required. The BCP-47 language code to use for translation of the input document. Specify up to 10 language codes here.
repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
BatchTranslateDocumentRequest.Builder | This builder for chaining. |
clone()
public BatchTranslateDocumentRequest.Builder clone()
Type | Description |
BatchTranslateDocumentRequest.Builder |
containsFormatConversions(String key)
public boolean containsFormatConversions(String key)
Optional. File format conversion map to be applied to all input files. Map's key is the original mime_type. Map's value is the target mime_type of translated documents. Supported file format conversion includes:
application/pdf
toapplication/vnd.openxmlformats-officedocument.wordprocessingml.document
If nothing specified, output files will be in the same format as the original file.
map<string, string> format_conversions = 8 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
key | String |
Type | Description |
boolean |
containsGlossaries(String key)
public boolean containsGlossaries(String key)
Optional. Glossaries to be applied. It's keyed by target language code.
map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
key | String |
Type | Description |
boolean |
containsModels(String key)
public boolean containsModels(String key)
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.
map<string, string> models = 6 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
key | String |
Type | Description |
boolean |
getDefaultInstanceForType()
public BatchTranslateDocumentRequest getDefaultInstanceForType()
Type | Description |
BatchTranslateDocumentRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
getFormatConversions()
public Map<String,String> getFormatConversions()
Use #getFormatConversionsMap() instead.
Type | Description |
Map<String,String> |
getFormatConversionsCount()
public int getFormatConversionsCount()
Optional. File format conversion map to be applied to all input files. Map's key is the original mime_type. Map's value is the target mime_type of translated documents. Supported file format conversion includes:
application/pdf
toapplication/vnd.openxmlformats-officedocument.wordprocessingml.document
If nothing specified, output files will be in the same format as the original file.
map<string, string> format_conversions = 8 [(.google.api.field_behavior) = OPTIONAL];
Type | Description |
int |
getFormatConversionsMap()
public Map<String,String> getFormatConversionsMap()
Optional. File format conversion map to be applied to all input files. Map's key is the original mime_type. Map's value is the target mime_type of translated documents. Supported file format conversion includes:
application/pdf
toapplication/vnd.openxmlformats-officedocument.wordprocessingml.document
If nothing specified, output files will be in the same format as the original file.
map<string, string> format_conversions = 8 [(.google.api.field_behavior) = OPTIONAL];
Type | Description |
Map<String,String> |
getFormatConversionsOrDefault(String key, String defaultValue)
public String getFormatConversionsOrDefault(String key, String defaultValue)
Optional. File format conversion map to be applied to all input files. Map's key is the original mime_type. Map's value is the target mime_type of translated documents. Supported file format conversion includes:
application/pdf
toapplication/vnd.openxmlformats-officedocument.wordprocessingml.document
If nothing specified, output files will be in the same format as the original file.
map<string, string> format_conversions = 8 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
key | String |
defaultValue | String |
Type | Description |
String |
getFormatConversionsOrThrow(String key)
public String getFormatConversionsOrThrow(String key)
Optional. File format conversion map to be applied to all input files. Map's key is the original mime_type. Map's value is the target mime_type of translated documents. Supported file format conversion includes:
application/pdf
toapplication/vnd.openxmlformats-officedocument.wordprocessingml.document
If nothing specified, output files will be in the same format as the original file.
map<string, string> format_conversions = 8 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
key | String |
Type | Description |
String |
getGlossaries()
public Map<String,TranslateTextGlossaryConfig> getGlossaries()
Use #getGlossariesMap() instead.
Type | Description |
Map<String,TranslateTextGlossaryConfig> |
getGlossariesCount()
public int getGlossariesCount()
Optional. Glossaries to be applied. It's keyed by target language code.
map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
Type | Description |
int |
getGlossariesMap()
public Map<String,TranslateTextGlossaryConfig> getGlossariesMap()
Optional. Glossaries to be applied. It's keyed by target language code.
map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
Type | Description |
Map<String,TranslateTextGlossaryConfig> |
getGlossariesOrDefault(String key, TranslateTextGlossaryConfig defaultValue)
public TranslateTextGlossaryConfig getGlossariesOrDefault(String key, TranslateTextGlossaryConfig defaultValue)
Optional. Glossaries to be applied. It's keyed by target language code.
map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
key | String |
defaultValue | TranslateTextGlossaryConfig |
Type | Description |
TranslateTextGlossaryConfig |
getGlossariesOrThrow(String key)
public TranslateTextGlossaryConfig getGlossariesOrThrow(String key)
Optional. Glossaries to be applied. It's keyed by target language code.
map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
key | String |
Type | Description |
TranslateTextGlossaryConfig |
getInputConfigs(int index)
public BatchDocumentInputConfig getInputConfigs(int index)
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
index | int |
Type | Description |
BatchDocumentInputConfig |
getInputConfigsBuilder(int index)
public BatchDocumentInputConfig.Builder getInputConfigsBuilder(int index)
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
index | int |
Type | Description |
BatchDocumentInputConfig.Builder |
getInputConfigsBuilderList()
public List<BatchDocumentInputConfig.Builder> getInputConfigsBuilderList()
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
List<Builder> |
getInputConfigsCount()
public int getInputConfigsCount()
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
int |
getInputConfigsList()
public List<BatchDocumentInputConfig> getInputConfigsList()
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
List<BatchDocumentInputConfig> |
getInputConfigsOrBuilder(int index)
public BatchDocumentInputConfigOrBuilder getInputConfigsOrBuilder(int index)
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
index | int |
Type | Description |
BatchDocumentInputConfigOrBuilder |
getInputConfigsOrBuilderList()
public List<? extends BatchDocumentInputConfigOrBuilder> getInputConfigsOrBuilderList()
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
List<? extends com.google.cloud.translate.v3beta1.BatchDocumentInputConfigOrBuilder> |
getModels()
public Map<String,String> getModels()
Use #getModelsMap() instead.
Type | Description |
Map<String,String> |
getModelsCount()
public int getModelsCount()
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.
map<string, string> models = 6 [(.google.api.field_behavior) = OPTIONAL];
Type | Description |
int |
getModelsMap()
public Map<String,String> getModelsMap()
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.
map<string, string> models = 6 [(.google.api.field_behavior) = OPTIONAL];
Type | Description |
Map<String,String> |
getModelsOrDefault(String key, String defaultValue)
public String getModelsOrDefault(String key, String defaultValue)
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.
map<string, string> models = 6 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
key | String |
defaultValue | String |
Type | Description |
String |
getModelsOrThrow(String key)
public String getModelsOrThrow(String key)
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.
map<string, string> models = 6 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
key | String |
Type | Description |
String |
getMutableFormatConversions()
public Map<String,String> getMutableFormatConversions()
Use alternate mutation accessors instead.
Type | Description |
Map<String,String> |
getMutableGlossaries()
public Map<String,TranslateTextGlossaryConfig> getMutableGlossaries()
Use alternate mutation accessors instead.
Type | Description |
Map<String,TranslateTextGlossaryConfig> |
getMutableModels()
public Map<String,String> getMutableModels()
Use alternate mutation accessors instead.
Type | Description |
Map<String,String> |
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.
.google.cloud.translation.v3beta1.BatchDocumentOutputConfig output_config = 5 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
BatchDocumentOutputConfig | The outputConfig. |
getOutputConfigBuilder()
public BatchDocumentOutputConfig.Builder getOutputConfigBuilder()
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.
.google.cloud.translation.v3beta1.BatchDocumentOutputConfig output_config = 5 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
BatchDocumentOutputConfig.Builder |
getOutputConfigOrBuilder()
public BatchDocumentOutputConfigOrBuilder getOutputConfigOrBuilder()
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.
.google.cloud.translation.v3beta1.BatchDocumentOutputConfig output_config = 5 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
BatchDocumentOutputConfigOrBuilder |
getParent()
public String getParent()
Required. Location to make a regional call.
Format: projects/{project-number-or-id}/locations/{location-id}
.
The global
location 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.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Type | Description |
String | The parent. |
getParentBytes()
public ByteString getParentBytes()
Required. Location to make a regional call.
Format: projects/{project-number-or-id}/locations/{location-id}
.
The global
location 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.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Type | Description |
ByteString | The bytes for parent. |
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).
string source_language_code = 2 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
String | The sourceLanguageCode. |
getSourceLanguageCodeBytes()
public ByteString getSourceLanguageCodeBytes()
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).
string source_language_code = 2 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
ByteString | The bytes for sourceLanguageCode. |
getTargetLanguageCodes(int index)
public String getTargetLanguageCodes(int index)
Required. The BCP-47 language code to use for translation of the input document. Specify up to 10 language codes here.
repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
index | int The index of the element to return. |
Type | Description |
String | The targetLanguageCodes at the given index. |
getTargetLanguageCodesBytes(int index)
public ByteString getTargetLanguageCodesBytes(int index)
Required. The BCP-47 language code to use for translation of the input document. Specify up to 10 language codes here.
repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
index | int The index of the value to return. |
Type | Description |
ByteString | The bytes of the targetLanguageCodes at the given index. |
getTargetLanguageCodesCount()
public int getTargetLanguageCodesCount()
Required. The BCP-47 language code to use for translation of the input document. Specify up to 10 language codes here.
repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
int | The count of targetLanguageCodes. |
getTargetLanguageCodesList()
public ProtocolStringList getTargetLanguageCodesList()
Required. The BCP-47 language code to use for translation of the input document. Specify up to 10 language codes here.
repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
ProtocolStringList | A list containing the targetLanguageCodes. |
hasOutputConfig()
public boolean hasOutputConfig()
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.
.google.cloud.translation.v3beta1.BatchDocumentOutputConfig output_config = 5 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
boolean | Whether the outputConfig field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Name | Description |
number | int |
Type | Description |
MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Name | Description |
number | int |
Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(BatchTranslateDocumentRequest other)
public BatchTranslateDocumentRequest.Builder mergeFrom(BatchTranslateDocumentRequest other)
Name | Description |
other | BatchTranslateDocumentRequest |
Type | Description |
BatchTranslateDocumentRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public BatchTranslateDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
BatchTranslateDocumentRequest.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public BatchTranslateDocumentRequest.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
BatchTranslateDocumentRequest.Builder |
mergeOutputConfig(BatchDocumentOutputConfig value)
public BatchTranslateDocumentRequest.Builder mergeOutputConfig(BatchDocumentOutputConfig value)
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.
.google.cloud.translation.v3beta1.BatchDocumentOutputConfig output_config = 5 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
value | BatchDocumentOutputConfig |
Type | Description |
BatchTranslateDocumentRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final BatchTranslateDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
BatchTranslateDocumentRequest.Builder |
putAllFormatConversions(Map<String,String> values)
public BatchTranslateDocumentRequest.Builder putAllFormatConversions(Map<String,String> values)
Optional. File format conversion map to be applied to all input files. Map's key is the original mime_type. Map's value is the target mime_type of translated documents. Supported file format conversion includes:
application/pdf
toapplication/vnd.openxmlformats-officedocument.wordprocessingml.document
If nothing specified, output files will be in the same format as the original file.
map<string, string> format_conversions = 8 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
values | Map<String,String> |
Type | Description |
BatchTranslateDocumentRequest.Builder |
putAllGlossaries(Map<String,TranslateTextGlossaryConfig> values)
public BatchTranslateDocumentRequest.Builder putAllGlossaries(Map<String,TranslateTextGlossaryConfig> values)
Optional. Glossaries to be applied. It's keyed by target language code.
map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
values | Map<String,TranslateTextGlossaryConfig> |
Type | Description |
BatchTranslateDocumentRequest.Builder |
putAllModels(Map<String,String> values)
public BatchTranslateDocumentRequest.Builder putAllModels(Map<String,String> values)
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.
map<string, string> models = 6 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
values | Map<String,String> |
Type | Description |
BatchTranslateDocumentRequest.Builder |
putFormatConversions(String key, String value)
public BatchTranslateDocumentRequest.Builder putFormatConversions(String key, String value)
Optional. File format conversion map to be applied to all input files. Map's key is the original mime_type. Map's value is the target mime_type of translated documents. Supported file format conversion includes:
application/pdf
toapplication/vnd.openxmlformats-officedocument.wordprocessingml.document
If nothing specified, output files will be in the same format as the original file.
map<string, string> format_conversions = 8 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
key | String |
value | String |
Type | Description |
BatchTranslateDocumentRequest.Builder |
putGlossaries(String key, TranslateTextGlossaryConfig value)
public BatchTranslateDocumentRequest.Builder putGlossaries(String key, TranslateTextGlossaryConfig value)
Optional. Glossaries to be applied. It's keyed by target language code.
map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
key | String |
value | TranslateTextGlossaryConfig |
Type | Description |
BatchTranslateDocumentRequest.Builder |
putModels(String key, String value)
public BatchTranslateDocumentRequest.Builder putModels(String key, String value)
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.
map<string, string> models = 6 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
key | String |
value | String |
Type | Description |
BatchTranslateDocumentRequest.Builder |
removeFormatConversions(String key)
public BatchTranslateDocumentRequest.Builder removeFormatConversions(String key)
Optional. File format conversion map to be applied to all input files. Map's key is the original mime_type. Map's value is the target mime_type of translated documents. Supported file format conversion includes:
application/pdf
toapplication/vnd.openxmlformats-officedocument.wordprocessingml.document
If nothing specified, output files will be in the same format as the original file.
map<string, string> format_conversions = 8 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
key | String |
Type | Description |
BatchTranslateDocumentRequest.Builder |
removeGlossaries(String key)
public BatchTranslateDocumentRequest.Builder removeGlossaries(String key)
Optional. Glossaries to be applied. It's keyed by target language code.
map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
key | String |
Type | Description |
BatchTranslateDocumentRequest.Builder |
removeInputConfigs(int index)
public BatchTranslateDocumentRequest.Builder removeInputConfigs(int index)
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
index | int |
Type | Description |
BatchTranslateDocumentRequest.Builder |
removeModels(String key)
public BatchTranslateDocumentRequest.Builder removeModels(String key)
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.
map<string, string> models = 6 [(.google.api.field_behavior) = OPTIONAL];
Name | Description |
key | String |
Type | Description |
BatchTranslateDocumentRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public BatchTranslateDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
BatchTranslateDocumentRequest.Builder |
setInputConfigs(int index, BatchDocumentInputConfig value)
public BatchTranslateDocumentRequest.Builder setInputConfigs(int index, BatchDocumentInputConfig value)
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
index | int |
value | BatchDocumentInputConfig |
Type | Description |
BatchTranslateDocumentRequest.Builder |
setInputConfigs(int index, BatchDocumentInputConfig.Builder builderForValue)
public BatchTranslateDocumentRequest.Builder setInputConfigs(int index, BatchDocumentInputConfig.Builder builderForValue)
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.
repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
index | int |
builderForValue | BatchDocumentInputConfig.Builder |
Type | Description |
BatchTranslateDocumentRequest.Builder |
setOutputConfig(BatchDocumentOutputConfig value)
public BatchTranslateDocumentRequest.Builder setOutputConfig(BatchDocumentOutputConfig value)
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.
.google.cloud.translation.v3beta1.BatchDocumentOutputConfig output_config = 5 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
value | BatchDocumentOutputConfig |
Type | Description |
BatchTranslateDocumentRequest.Builder |
setOutputConfig(BatchDocumentOutputConfig.Builder builderForValue)
public BatchTranslateDocumentRequest.Builder setOutputConfig(BatchDocumentOutputConfig.Builder builderForValue)
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.
.google.cloud.translation.v3beta1.BatchDocumentOutputConfig output_config = 5 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
builderForValue | BatchDocumentOutputConfig.Builder |
Type | Description |
BatchTranslateDocumentRequest.Builder |
setParent(String value)
public BatchTranslateDocumentRequest.Builder setParent(String value)
Required. Location to make a regional call.
Format: projects/{project-number-or-id}/locations/{location-id}
.
The global
location 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.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Name | Description |
value | String The parent to set. |
Type | Description |
BatchTranslateDocumentRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public BatchTranslateDocumentRequest.Builder setParentBytes(ByteString value)
Required. Location to make a regional call.
Format: projects/{project-number-or-id}/locations/{location-id}
.
The global
location 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.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Name | Description |
value | ByteString The bytes for parent to set. |
Type | Description |
BatchTranslateDocumentRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public BatchTranslateDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
BatchTranslateDocumentRequest.Builder |
setSourceLanguageCode(String value)
public BatchTranslateDocumentRequest.Builder setSourceLanguageCode(String value)
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).
string source_language_code = 2 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
value | String The sourceLanguageCode to set. |
Type | Description |
BatchTranslateDocumentRequest.Builder | This builder for chaining. |
setSourceLanguageCodeBytes(ByteString value)
public BatchTranslateDocumentRequest.Builder setSourceLanguageCodeBytes(ByteString value)
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).
string source_language_code = 2 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
value | ByteString The bytes for sourceLanguageCode to set. |
Type | Description |
BatchTranslateDocumentRequest.Builder | This builder for chaining. |
setTargetLanguageCodes(int index, String value)
public BatchTranslateDocumentRequest.Builder setTargetLanguageCodes(int index, String value)
Required. The BCP-47 language code to use for translation of the input document. Specify up to 10 language codes here.
repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
index | int The index to set the value at. |
value | String The targetLanguageCodes to set. |
Type | Description |
BatchTranslateDocumentRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final BatchTranslateDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
BatchTranslateDocumentRequest.Builder |