public final class BatchTranslateTextRequest extends GeneratedMessageV3 implements BatchTranslateTextRequestOrBuilder
The batch translation request.
Protobuf type google.cloud.translation.v3.BatchTranslateTextRequest
Static Fields
GLOSSARIES_FIELD_NUMBER
public static final int GLOSSARIES_FIELD_NUMBER
Field Value
INPUT_CONFIGS_FIELD_NUMBER
public static final int INPUT_CONFIGS_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_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 BatchTranslateTextRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static BatchTranslateTextRequest.Builder newBuilder()
Returns
newBuilder(BatchTranslateTextRequest prototype)
public static BatchTranslateTextRequest.Builder newBuilder(BatchTranslateTextRequest prototype)
Parameter
Returns
parseDelimitedFrom(InputStream input)
public static BatchTranslateTextRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchTranslateTextRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static BatchTranslateTextRequest parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchTranslateTextRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static BatchTranslateTextRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchTranslateTextRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static BatchTranslateTextRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchTranslateTextRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static BatchTranslateTextRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchTranslateTextRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static BatchTranslateTextRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BatchTranslateTextRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<BatchTranslateTextRequest> parser()
Returns
Methods
containsGlossaries(String key)
public boolean containsGlossaries(String key)
Optional. Glossaries to be applied for translation.
It's keyed by target language code.
map<string, .google.cloud.translation.v3.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
containsLabels(String key)
public boolean containsLabels(String key)
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.
map<string, string> labels = 9 [(.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 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public BatchTranslateTextRequest getDefaultInstanceForType()
Returns
getGlossaries()
public Map<String,TranslateTextGlossaryConfig> getGlossaries()
Returns
getGlossariesCount()
public int getGlossariesCount()
Optional. Glossaries to be applied for translation.
It's keyed by target language code.
map<string, .google.cloud.translation.v3.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
getGlossariesMap()
public Map<String,TranslateTextGlossaryConfig> getGlossariesMap()
Optional. Glossaries to be applied for translation.
It's keyed by target language code.
map<string, .google.cloud.translation.v3.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 for translation.
It's keyed by target language code.
map<string, .google.cloud.translation.v3.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
getGlossariesOrThrow(String key)
public TranslateTextGlossaryConfig getGlossariesOrThrow(String key)
Optional. Glossaries to be applied for translation.
It's keyed by target language code.
map<string, .google.cloud.translation.v3.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
getInputConfigs(int index)
public InputConfig getInputConfigs(int index)
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.
repeated .google.cloud.translation.v3.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];
getInputConfigsCount()
public int getInputConfigsCount()
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.
repeated .google.cloud.translation.v3.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];
getInputConfigsList()
public List<InputConfig> getInputConfigsList()
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.
repeated .google.cloud.translation.v3.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];
getInputConfigsOrBuilder(int index)
public InputConfigOrBuilder getInputConfigsOrBuilder(int index)
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.
repeated .google.cloud.translation.v3.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];
getInputConfigsOrBuilderList()
public List<? extends InputConfigOrBuilder> getInputConfigsOrBuilderList()
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.
repeated .google.cloud.translation.v3.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
List<? extends com.google.cloud.translate.v3.InputConfigOrBuilder> | |
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
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.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
getLabelsMap()
public Map<String,String> getLabelsMap()
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.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
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.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
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.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
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 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 = 4 [(.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 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 = 4 [(.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 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 = 4 [(.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 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
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.
.google.cloud.translation.v3.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
getOutputConfigOrBuilder()
public OutputConfigOrBuilder 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.v3.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
getParent()
public String getParent()
Required. Location to make a call. Must refer to a caller's project.
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 call. Must refer to a caller's project.
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<BatchTranslateTextRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSourceLanguageCode()
public String getSourceLanguageCode()
Required. Source language code.
string source_language_code = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
String | The sourceLanguageCode.
|
getSourceLanguageCodeBytes()
public ByteString getSourceLanguageCodeBytes()
Required. Source language code.
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. 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. 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. 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. 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.v3.OutputConfig output_config = 6 [(.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
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public BatchTranslateTextRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BatchTranslateTextRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public BatchTranslateTextRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
