public final class BatchTranslateDocumentRequest extends GeneratedMessageV3 implements BatchTranslateDocumentRequestOrBuilder
The BatchTranslateDocument request.
Protobuf type google.cloud.translation.v3beta1.BatchTranslateDocumentRequest
Static Fields
public static final int FORMAT_CONVERSIONS_FIELD_NUMBER
Field Value
GLOSSARIES_FIELD_NUMBER
public static final int GLOSSARIES_FIELD_NUMBER
Field Value
public static final int INPUT_CONFIGS_FIELD_NUMBER
Field Value
MODELS_FIELD_NUMBER
public static final int MODELS_FIELD_NUMBER
Field Value
OUTPUT_CONFIG_FIELD_NUMBER
public static final int OUTPUT_CONFIG_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
SOURCE_LANGUAGE_CODE_FIELD_NUMBER
public static final int SOURCE_LANGUAGE_CODE_FIELD_NUMBER
Field Value
TARGET_LANGUAGE_CODES_FIELD_NUMBER
public static final int TARGET_LANGUAGE_CODES_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static BatchTranslateDocumentRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static BatchTranslateDocumentRequest.Builder newBuilder()
Returns
newBuilder(BatchTranslateDocumentRequest prototype)
public static BatchTranslateDocumentRequest.Builder newBuilder(BatchTranslateDocumentRequest prototype)
Parameter
Returns
public static BatchTranslateDocumentRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static BatchTranslateDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static BatchTranslateDocumentRequest parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchTranslateDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static BatchTranslateDocumentRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchTranslateDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static BatchTranslateDocumentRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static BatchTranslateDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static BatchTranslateDocumentRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static BatchTranslateDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static BatchTranslateDocumentRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BatchTranslateDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<BatchTranslateDocumentRequest> parser()
Returns
Methods
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 to
application/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];
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];
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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public BatchTranslateDocumentRequest getDefaultInstanceForType()
Returns
public Map<String,String> getFormatConversions()
Returns
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 to
application/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];
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 to
application/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];
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 to
application/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];
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 to
application/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];
getGlossaries()
public Map<String,TranslateTextGlossaryConfig> getGlossaries()
Returns
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];
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];
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];
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];
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
|
Returns
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];
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];
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
|
Returns
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()
Returns
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];
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];
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];
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];
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];
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];
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) = { ... }
getParserForType()
public Parser<BatchTranslateDocumentRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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.
|
Returns
| 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.
|
Returns
| 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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
| Name |
Description |
| number |
int
|
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public BatchTranslateDocumentRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BatchTranslateDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public BatchTranslateDocumentRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
