Class TranslateTextRequest.Builder (2.54.0) 

public static final class TranslateTextRequest.Builder extends GeneratedMessageV3.Builder<TranslateTextRequest.Builder> implements TranslateTextRequestOrBuilder

The request message for synchronous translation.

Protobuf type google.cloud.translation.v3.TranslateTextRequest

Inheritance

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllContents(Iterable<String> values)

public TranslateTextRequest.Builder addAllContents(Iterable<String> values)

Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

repeated string contents = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<String>

The contents to add.
Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

addContents(String value)

public TranslateTextRequest.Builder addContents(String value)

Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

repeated string contents = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The contents to add.
Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

addContentsBytes(ByteString value)

public TranslateTextRequest.Builder addContentsBytes(ByteString value)

Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

repeated string contents = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes of the contents to add.
Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TranslateTextRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TranslateTextRequest.Builder
Overrides

build()

public TranslateTextRequest build()
Returns
Type Description
TranslateTextRequest

buildPartial()

public TranslateTextRequest buildPartial()
Returns
Type Description
TranslateTextRequest

clear()

public TranslateTextRequest.Builder clear()
Returns
Type Description
TranslateTextRequest.Builder
Overrides

clearContents()

public TranslateTextRequest.Builder clearContents()

Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

repeated string contents = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TranslateTextRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TranslateTextRequest.Builder
Overrides

clearGlossaryConfig()

public TranslateTextRequest.Builder clearGlossaryConfig()

Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.

.google.cloud.translation.v3.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TranslateTextRequest.Builder

clearLabels()

public TranslateTextRequest.Builder clearLabels()
Returns
Type Description
TranslateTextRequest.Builder

clearMimeType()

public TranslateTextRequest.Builder clearMimeType()

Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".

string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

clearModel()

public TranslateTextRequest.Builder clearModel()

Optional. The model type requested for this translation.

The 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,

  • Translation LLM models: projects/{project-number-or-id}/locations/{location-id}/models/general/translation-llm,

    For global (non-regionalized) requests, use location-id global. For example, projects/{project-number-or-id}/locations/global/models/general/nmt.

    If not provided, the default Google model (NMT) will be used

string model = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TranslateTextRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TranslateTextRequest.Builder
Overrides

clearParent()

public TranslateTextRequest.Builder clearParent()

Required. Project or location to make a call. Must refer to a caller's project.

Format: projects/{project-number-or-id} or projects/{project-number-or-id}/locations/{location-id}.

For global calls, use projects/{project-number-or-id}/locations/global or projects/{project-number-or-id}.

Non-global location is required for requests using AutoML models or custom glossaries.

Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.

string parent = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

clearSourceLanguageCode()

public TranslateTextRequest.Builder clearSourceLanguageCode()

Optional. The ISO-639 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response.

string source_language_code = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

clearTargetLanguageCode()

public TranslateTextRequest.Builder clearTargetLanguageCode()

Required. The ISO-639 language code to use for translation of the input text, set to one of the language codes listed in Language Support.

string target_language_code = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

clearTransliterationConfig()

public TranslateTextRequest.Builder clearTransliterationConfig()

Optional. Transliteration to be applied.

.google.cloud.translation.v3.TransliterationConfig transliteration_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TranslateTextRequest.Builder

clone()

public TranslateTextRequest.Builder clone()
Returns
Type Description
TranslateTextRequest.Builder
Overrides

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 = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getContents(int index)

public String getContents(int index)

Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

repeated string contents = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The contents at the given index.

getContentsBytes(int index)

public ByteString getContentsBytes(int index)

Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

repeated string contents = 1 [(.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 contents at the given index.

getContentsCount()

public int getContentsCount()

Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

repeated string contents = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of contents.

getContentsList()

public ProtocolStringList getContentsList()

Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

repeated string contents = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProtocolStringList

A list containing the contents.

getDefaultInstanceForType()

public TranslateTextRequest getDefaultInstanceForType()
Returns
Type Description
TranslateTextRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getGlossaryConfig()

public TranslateTextGlossaryConfig getGlossaryConfig()

Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.

.google.cloud.translation.v3.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TranslateTextGlossaryConfig

The glossaryConfig.

getGlossaryConfigBuilder()

public TranslateTextGlossaryConfig.Builder getGlossaryConfigBuilder()

Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.

.google.cloud.translation.v3.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TranslateTextGlossaryConfig.Builder

getGlossaryConfigOrBuilder()

public TranslateTextGlossaryConfigOrBuilder getGlossaryConfigOrBuilder()

Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.

.google.cloud.translation.v3.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TranslateTextGlossaryConfigOrBuilder

getLabels() (deprecated)

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 = 10 [(.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 = 10 [(.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 = 10 [(.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 = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getMimeType()

public String getMimeType()

Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".

string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".

string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for mimeType.

getModel()

public String getModel()

Optional. The model type requested for this translation.

The 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,

  • Translation LLM models: projects/{project-number-or-id}/locations/{location-id}/models/general/translation-llm,

    For global (non-regionalized) requests, use location-id global. For example, projects/{project-number-or-id}/locations/global/models/general/nmt.

    If not provided, the default Google model (NMT) will be used

string model = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The model.

getModelBytes()

public ByteString getModelBytes()

Optional. The model type requested for this translation.

The 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,

  • Translation LLM models: projects/{project-number-or-id}/locations/{location-id}/models/general/translation-llm,

    For global (non-regionalized) requests, use location-id global. For example, projects/{project-number-or-id}/locations/global/models/general/nmt.

    If not provided, the default Google model (NMT) will be used

string model = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for model.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getParent()

public String getParent()

Required. Project or location to make a call. Must refer to a caller's project.

Format: projects/{project-number-or-id} or projects/{project-number-or-id}/locations/{location-id}.

For global calls, use projects/{project-number-or-id}/locations/global or projects/{project-number-or-id}.

Non-global location is required for requests using AutoML models or custom glossaries.

Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.

string parent = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Project or location to make a call. Must refer to a caller's project.

Format: projects/{project-number-or-id} or projects/{project-number-or-id}/locations/{location-id}.

For global calls, use projects/{project-number-or-id}/locations/global or projects/{project-number-or-id}.

Non-global location is required for requests using AutoML models or custom glossaries.

Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.

string parent = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getSourceLanguageCode()

public String getSourceLanguageCode()

Optional. The ISO-639 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response.

string source_language_code = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The sourceLanguageCode.

getSourceLanguageCodeBytes()

public ByteString getSourceLanguageCodeBytes()

Optional. The ISO-639 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response.

string source_language_code = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for sourceLanguageCode.

getTargetLanguageCode()

public String getTargetLanguageCode()

Required. The ISO-639 language code to use for translation of the input text, set to one of the language codes listed in Language Support.

string target_language_code = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The targetLanguageCode.

getTargetLanguageCodeBytes()

public ByteString getTargetLanguageCodeBytes()

Required. The ISO-639 language code to use for translation of the input text, set to one of the language codes listed in Language Support.

string target_language_code = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for targetLanguageCode.

getTransliterationConfig()

public TransliterationConfig getTransliterationConfig()

Optional. Transliteration to be applied.

.google.cloud.translation.v3.TransliterationConfig transliteration_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransliterationConfig

The transliterationConfig.

getTransliterationConfigBuilder()

public TransliterationConfig.Builder getTransliterationConfigBuilder()

Optional. Transliteration to be applied.

.google.cloud.translation.v3.TransliterationConfig transliteration_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransliterationConfig.Builder

getTransliterationConfigOrBuilder()

public TransliterationConfigOrBuilder getTransliterationConfigOrBuilder()

Optional. Transliteration to be applied.

.google.cloud.translation.v3.TransliterationConfig transliteration_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransliterationConfigOrBuilder

hasGlossaryConfig()

public boolean hasGlossaryConfig()

Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.

.google.cloud.translation.v3.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the glossaryConfig field is set.

hasTransliterationConfig()

public boolean hasTransliterationConfig()

Optional. Transliteration to be applied.

.google.cloud.translation.v3.TransliterationConfig transliteration_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the transliterationConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(TranslateTextRequest other)

public TranslateTextRequest.Builder mergeFrom(TranslateTextRequest other)
Parameter
Name Description
other TranslateTextRequest
Returns
Type Description
TranslateTextRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TranslateTextRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TranslateTextRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TranslateTextRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TranslateTextRequest.Builder
Overrides

mergeGlossaryConfig(TranslateTextGlossaryConfig value)

public TranslateTextRequest.Builder mergeGlossaryConfig(TranslateTextGlossaryConfig value)

Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.

.google.cloud.translation.v3.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value TranslateTextGlossaryConfig
Returns
Type Description
TranslateTextRequest.Builder

mergeTransliterationConfig(TransliterationConfig value)

public TranslateTextRequest.Builder mergeTransliterationConfig(TransliterationConfig value)

Optional. Transliteration to be applied.

.google.cloud.translation.v3.TransliterationConfig transliteration_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value TransliterationConfig
Returns
Type Description
TranslateTextRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TranslateTextRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TranslateTextRequest.Builder
Overrides

putAllLabels(Map<String,String> values)

public TranslateTextRequest.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 = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
TranslateTextRequest.Builder

putLabels(String key, String value)

public TranslateTextRequest.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 = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
TranslateTextRequest.Builder

removeLabels(String key)

public TranslateTextRequest.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 = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
TranslateTextRequest.Builder

setContents(int index, String value)

public TranslateTextRequest.Builder setContents(int index, String value)

Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

repeated string contents = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int

The index to set the value at.
value String

The contents to set.
Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TranslateTextRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TranslateTextRequest.Builder
Overrides

setGlossaryConfig(TranslateTextGlossaryConfig value)

public TranslateTextRequest.Builder setGlossaryConfig(TranslateTextGlossaryConfig value)

Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.

.google.cloud.translation.v3.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value TranslateTextGlossaryConfig
Returns
Type Description
TranslateTextRequest.Builder

setGlossaryConfig(TranslateTextGlossaryConfig.Builder builderForValue)

public TranslateTextRequest.Builder setGlossaryConfig(TranslateTextGlossaryConfig.Builder builderForValue)

Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.

.google.cloud.translation.v3.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue TranslateTextGlossaryConfig.Builder
Returns
Type Description
TranslateTextRequest.Builder

setMimeType(String value)

public TranslateTextRequest.Builder setMimeType(String value)

Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".

string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The mimeType to set.
Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

setMimeTypeBytes(ByteString value)

public TranslateTextRequest.Builder setMimeTypeBytes(ByteString value)

Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".

string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for mimeType to set.
Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

setModel(String value)

public TranslateTextRequest.Builder setModel(String value)

Optional. The model type requested for this translation.

The 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,

  • Translation LLM models: projects/{project-number-or-id}/locations/{location-id}/models/general/translation-llm,

    For global (non-regionalized) requests, use location-id global. For example, projects/{project-number-or-id}/locations/global/models/general/nmt.

    If not provided, the default Google model (NMT) will be used

string model = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The model to set.
Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

setModelBytes(ByteString value)

public TranslateTextRequest.Builder setModelBytes(ByteString value)

Optional. The model type requested for this translation.

The 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,

  • Translation LLM models: projects/{project-number-or-id}/locations/{location-id}/models/general/translation-llm,

    For global (non-regionalized) requests, use location-id global. For example, projects/{project-number-or-id}/locations/global/models/general/nmt.

    If not provided, the default Google model (NMT) will be used

string model = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for model to set.
Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

setParent(String value)

public TranslateTextRequest.Builder setParent(String value)

Required. Project or location to make a call. Must refer to a caller's project.

Format: projects/{project-number-or-id} or projects/{project-number-or-id}/locations/{location-id}.

For global calls, use projects/{project-number-or-id}/locations/global or projects/{project-number-or-id}.

Non-global location is required for requests using AutoML models or custom glossaries.

Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.

string parent = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public TranslateTextRequest.Builder setParentBytes(ByteString value)

Required. Project or location to make a call. Must refer to a caller's project.

Format: projects/{project-number-or-id} or projects/{project-number-or-id}/locations/{location-id}.

For global calls, use projects/{project-number-or-id}/locations/global or projects/{project-number-or-id}.

Non-global location is required for requests using AutoML models or custom glossaries.

Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.

string parent = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

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

public TranslateTextRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TranslateTextRequest.Builder
Overrides

setSourceLanguageCode(String value)

public TranslateTextRequest.Builder setSourceLanguageCode(String value)

Optional. The ISO-639 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response.

string source_language_code = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The sourceLanguageCode to set.
Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

setSourceLanguageCodeBytes(ByteString value)

public TranslateTextRequest.Builder setSourceLanguageCodeBytes(ByteString value)

Optional. The ISO-639 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response.

string source_language_code = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for sourceLanguageCode to set.
Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

setTargetLanguageCode(String value)

public TranslateTextRequest.Builder setTargetLanguageCode(String value)

Required. The ISO-639 language code to use for translation of the input text, set to one of the language codes listed in Language Support.

string target_language_code = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The targetLanguageCode to set.
Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

setTargetLanguageCodeBytes(ByteString value)

public TranslateTextRequest.Builder setTargetLanguageCodeBytes(ByteString value)

Required. The ISO-639 language code to use for translation of the input text, set to one of the language codes listed in Language Support.

string target_language_code = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for targetLanguageCode to set.
Returns
Type Description
TranslateTextRequest.Builder

This builder for chaining.

setTransliterationConfig(TransliterationConfig value)

public TranslateTextRequest.Builder setTransliterationConfig(TransliterationConfig value)

Optional. Transliteration to be applied.

.google.cloud.translation.v3.TransliterationConfig transliteration_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value TransliterationConfig
Returns
Type Description
TranslateTextRequest.Builder

setTransliterationConfig(TransliterationConfig.Builder builderForValue)

public TranslateTextRequest.Builder setTransliterationConfig(TransliterationConfig.Builder builderForValue)

Optional. Transliteration to be applied.

.google.cloud.translation.v3.TransliterationConfig transliteration_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue TransliterationConfig.Builder
Returns
Type Description
TranslateTextRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final TranslateTextRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TranslateTextRequest.Builder
Overrides