Class BatchTranslateTextRequest.Builder (2.29.0)

Version 2.29.0

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 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 BatchTranslateTextRequest.Builder extends GeneratedMessageV3.Builder<BatchTranslateTextRequest.Builder> implements BatchTranslateTextRequestOrBuilder

The batch translation request.

Protobuf type google.cloud.translation.v3.BatchTranslateTextRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BatchTranslateTextRequest.Builder

Implements

BatchTranslateTextRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllInputConfigs(Iterable<? extends InputConfig> values)

public BatchTranslateTextRequest.Builder addAllInputConfigs(Iterable<? extends InputConfig> values)

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];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.translate.v3.InputConfig>

Returns
Type	Description
BatchTranslateTextRequest.Builder

addAllTargetLanguageCodes(Iterable<String> values)

public BatchTranslateTextRequest.Builder addAllTargetLanguageCodes(Iterable<String> values)

Required. Specify up to 10 language codes here.

repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
values	Iterable<String> The targetLanguageCodes to add.

Returns
Type	Description
BatchTranslateTextRequest.Builder	This builder for chaining.

addInputConfigs(InputConfig value)

public BatchTranslateTextRequest.Builder addInputConfigs(InputConfig value)

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];

Parameter
Name	Description
value	InputConfig

Returns
Type	Description
BatchTranslateTextRequest.Builder

addInputConfigs(InputConfig.Builder builderForValue)

public BatchTranslateTextRequest.Builder addInputConfigs(InputConfig.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	InputConfig.Builder

Returns
Type	Description
BatchTranslateTextRequest.Builder

addInputConfigs(int index, InputConfig value)

public BatchTranslateTextRequest.Builder addInputConfigs(int index, InputConfig value)

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];

Parameters
Name	Description
index	int
value	InputConfig

Returns
Type	Description
BatchTranslateTextRequest.Builder

addInputConfigs(int index, InputConfig.Builder builderForValue)

public BatchTranslateTextRequest.Builder addInputConfigs(int index, InputConfig.Builder builderForValue)

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];

Parameters
Name	Description
index	int
builderForValue	InputConfig.Builder

Returns
Type	Description
BatchTranslateTextRequest.Builder

addInputConfigsBuilder()

public InputConfig.Builder addInputConfigsBuilder()

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];

Returns
Type	Description
InputConfig.Builder

addInputConfigsBuilder(int index)

public InputConfig.Builder addInputConfigsBuilder(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];

Parameter
Name	Description
index	int

Returns
Type	Description
InputConfig.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BatchTranslateTextRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
BatchTranslateTextRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addTargetLanguageCodes(String value)

public BatchTranslateTextRequest.Builder addTargetLanguageCodes(String value)

Required. Specify up to 10 language codes here.

repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The targetLanguageCodes to add.

Returns
Type	Description
BatchTranslateTextRequest.Builder	This builder for chaining.

addTargetLanguageCodesBytes(ByteString value)

public BatchTranslateTextRequest.Builder addTargetLanguageCodesBytes(ByteString value)

Required. Specify up to 10 language codes here.

repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes of the targetLanguageCodes to add.

Returns
Type	Description
BatchTranslateTextRequest.Builder	This builder for chaining.

build()

public BatchTranslateTextRequest build()

Returns
Type	Description
BatchTranslateTextRequest

buildPartial()

public BatchTranslateTextRequest buildPartial()

Returns
Type	Description
BatchTranslateTextRequest

clear()

public BatchTranslateTextRequest.Builder clear()

Returns
Type	Description
BatchTranslateTextRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public BatchTranslateTextRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
BatchTranslateTextRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearGlossaries()

public BatchTranslateTextRequest.Builder clearGlossaries()

Returns
Type	Description
BatchTranslateTextRequest.Builder

clearInputConfigs()

public BatchTranslateTextRequest.Builder clearInputConfigs()

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];

Returns
Type	Description
BatchTranslateTextRequest.Builder

clearLabels()

public BatchTranslateTextRequest.Builder clearLabels()

Returns
Type	Description
BatchTranslateTextRequest.Builder

clearModels()

public BatchTranslateTextRequest.Builder clearModels()

Returns
Type	Description
BatchTranslateTextRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchTranslateTextRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
BatchTranslateTextRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOutputConfig()

public BatchTranslateTextRequest.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.v3.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
BatchTranslateTextRequest.Builder

clearParent()

public BatchTranslateTextRequest.Builder clearParent()

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) = { ... }

Returns
Type	Description
BatchTranslateTextRequest.Builder	This builder for chaining.

clearSourceLanguageCode()

public BatchTranslateTextRequest.Builder clearSourceLanguageCode()

Required. Source language code.

string source_language_code = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
BatchTranslateTextRequest.Builder	This builder for chaining.

clearTargetLanguageCodes()

public BatchTranslateTextRequest.Builder clearTargetLanguageCodes()

Required. Specify up to 10 language codes here.

repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
BatchTranslateTextRequest.Builder	This builder for chaining.

clone()

public BatchTranslateTextRequest.Builder clone()

Returns
Type	Description
BatchTranslateTextRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

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];

Parameter
Name	Description
key	String

Returns
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 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];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getDefaultInstanceForType()

public BatchTranslateTextRequest getDefaultInstanceForType()

Returns
Type	Description
BatchTranslateTextRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getGlossaries()

public Map<String,TranslateTextGlossaryConfig> getGlossaries()

Use #getGlossariesMap() instead.

Returns
Type	Description
Map<String,TranslateTextGlossaryConfig>

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];

Returns
Type	Description
int

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];

Returns
Type	Description
Map<String,TranslateTextGlossaryConfig>

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];

Parameters
Name	Description
key	String
defaultValue	TranslateTextGlossaryConfig

Returns
Type	Description
TranslateTextGlossaryConfig

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];

Parameter
Name	Description
key	String

Returns
Type	Description
TranslateTextGlossaryConfig

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];

Parameter
Name	Description
index	int

Returns
Type	Description
InputConfig

getInputConfigsBuilder(int index)

public InputConfig.Builder getInputConfigsBuilder(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];

Parameter
Name	Description
index	int

Returns
Type	Description
InputConfig.Builder

getInputConfigsBuilderList()

public List<InputConfig.Builder> getInputConfigsBuilderList()

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];

Returns
Type	Description
List<Builder>

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];

Returns
Type	Description
int

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];

Returns
Type	Description
List<InputConfig>

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];

Parameter
Name	Description
index	int

Returns
Type	Description
InputConfigOrBuilder

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];

Returns
Type	Description
List<? extends com.google.cloud.translate.v3.InputConfigOrBuilder>

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

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];

Returns
Type	Description
int

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];

Returns
Type	Description
Map<String,String>

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];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

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];

Parameter
Name	Description
key	String

Returns
Type	Description
String

getModels()

public Map<String,String> getModels()

Use #getModelsMap() instead.

Returns
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 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];

Returns
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 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];

Returns
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 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];

Parameters
Name	Description
key	String
defaultValue	String

Returns
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 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];

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMutableGlossaries()

public Map<String,TranslateTextGlossaryConfig> getMutableGlossaries()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,TranslateTextGlossaryConfig>

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,String>

getMutableModels()

public Map<String,String> getMutableModels()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,String>

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];

Returns
Type	Description
OutputConfig	The outputConfig.

getOutputConfigBuilder()

public OutputConfig.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.v3.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
OutputConfig.Builder

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];

Returns
Type	Description
OutputConfigOrBuilder

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) = { ... }

Returns
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) = { ... }

Returns
Type	Description
ByteString	The bytes for parent.

getSourceLanguageCode()

public String getSourceLanguageCode()

Required. Source language code.

string source_language_code = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The sourceLanguageCode.

getSourceLanguageCodeBytes()

public ByteString getSourceLanguageCodeBytes()

Required. Source language code.

string source_language_code = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
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];

Parameter
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];

Parameter
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];

Returns
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];

Returns
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.v3.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the outputConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(BatchTranslateTextRequest other)

public BatchTranslateTextRequest.Builder mergeFrom(BatchTranslateTextRequest other)

Parameter
Name	Description
other	BatchTranslateTextRequest

Returns
Type	Description
BatchTranslateTextRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchTranslateTextRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchTranslateTextRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public BatchTranslateTextRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
BatchTranslateTextRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeOutputConfig(OutputConfig value)

public BatchTranslateTextRequest.Builder mergeOutputConfig(OutputConfig 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.v3.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	OutputConfig

Returns
Type	Description
BatchTranslateTextRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchTranslateTextRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
BatchTranslateTextRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAllGlossaries(Map<String,TranslateTextGlossaryConfig> values)

public BatchTranslateTextRequest.Builder putAllGlossaries(Map<String,TranslateTextGlossaryConfig> values)

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];

Parameter
Name	Description
values	Map<String,TranslateTextGlossaryConfig>

Returns
Type	Description
BatchTranslateTextRequest.Builder

putAllLabels(Map<String,String> values)

public BatchTranslateTextRequest.Builder putAllLabels(Map<String,String> values)

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];

Parameter
Name	Description
values	Map<String,String>

Returns
Type	Description
BatchTranslateTextRequest.Builder

putAllModels(Map<String,String> values)

public BatchTranslateTextRequest.Builder putAllModels(Map<String,String> values)

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];

Parameter
Name	Description
values	Map<String,String>

Returns
Type	Description
BatchTranslateTextRequest.Builder

putGlossaries(String key, TranslateTextGlossaryConfig value)

public BatchTranslateTextRequest.Builder putGlossaries(String key, TranslateTextGlossaryConfig value)

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];

Parameters
Name	Description
key	String
value	TranslateTextGlossaryConfig

Returns
Type	Description
BatchTranslateTextRequest.Builder

putLabels(String key, String value)

public BatchTranslateTextRequest.Builder putLabels(String key, String value)

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];

Parameters
Name	Description
key	String
value	String

Returns
Type	Description
BatchTranslateTextRequest.Builder

putModels(String key, String value)

public BatchTranslateTextRequest.Builder putModels(String key, String value)

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];

Parameters
Name	Description
key	String
value	String

Returns
Type	Description
BatchTranslateTextRequest.Builder

removeGlossaries(String key)

public BatchTranslateTextRequest.Builder removeGlossaries(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];

Parameter
Name	Description
key	String

Returns
Type	Description
BatchTranslateTextRequest.Builder

removeInputConfigs(int index)

public BatchTranslateTextRequest.Builder removeInputConfigs(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];

Parameter
Name	Description
index	int

Returns
Type	Description
BatchTranslateTextRequest.Builder

removeLabels(String key)

public BatchTranslateTextRequest.Builder removeLabels(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];

Parameter
Name	Description
key	String

Returns
Type	Description
BatchTranslateTextRequest.Builder

removeModels(String key)

public BatchTranslateTextRequest.Builder removeModels(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];

Parameter
Name	Description
key	String

Returns
Type	Description
BatchTranslateTextRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public BatchTranslateTextRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
BatchTranslateTextRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setInputConfigs(int index, InputConfig value)

public BatchTranslateTextRequest.Builder setInputConfigs(int index, InputConfig value)

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];

Parameters
Name	Description
index	int
value	InputConfig

Returns
Type	Description
BatchTranslateTextRequest.Builder

setInputConfigs(int index, InputConfig.Builder builderForValue)

public BatchTranslateTextRequest.Builder setInputConfigs(int index, InputConfig.Builder builderForValue)

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];

Parameters
Name	Description
index	int
builderForValue	InputConfig.Builder

Returns
Type	Description
BatchTranslateTextRequest.Builder

setOutputConfig(OutputConfig value)

public BatchTranslateTextRequest.Builder setOutputConfig(OutputConfig 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.v3.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	OutputConfig

Returns
Type	Description
BatchTranslateTextRequest.Builder

setOutputConfig(OutputConfig.Builder builderForValue)

public BatchTranslateTextRequest.Builder setOutputConfig(OutputConfig.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.v3.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
builderForValue	OutputConfig.Builder

Returns
Type	Description
BatchTranslateTextRequest.Builder

setParent(String value)

public BatchTranslateTextRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name	Description
value	String The parent to set.

Returns
Type	Description
BatchTranslateTextRequest.Builder	This builder for chaining.

setParentBytes(ByteString value)

public BatchTranslateTextRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name	Description
value	ByteString The bytes for parent to set.

Returns
Type	Description
BatchTranslateTextRequest.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BatchTranslateTextRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
BatchTranslateTextRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSourceLanguageCode(String value)

public BatchTranslateTextRequest.Builder setSourceLanguageCode(String value)

Required. Source language code.

string source_language_code = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The sourceLanguageCode to set.

Returns
Type	Description
BatchTranslateTextRequest.Builder	This builder for chaining.

setSourceLanguageCodeBytes(ByteString value)

public BatchTranslateTextRequest.Builder setSourceLanguageCodeBytes(ByteString value)

Required. Source language code.

string source_language_code = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for sourceLanguageCode to set.

Returns
Type	Description
BatchTranslateTextRequest.Builder	This builder for chaining.

setTargetLanguageCodes(int index, String value)

public BatchTranslateTextRequest.Builder setTargetLanguageCodes(int index, String value)

Required. Specify up to 10 language codes here.

repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
index	int The index to set the value at.
value	String The targetLanguageCodes to set.

Returns
Type	Description
BatchTranslateTextRequest.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchTranslateTextRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
BatchTranslateTextRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)