Class TranslateTextRequest.Builder (2.1.13)

Version 2.1.13

• 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 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

Implements

TranslateTextRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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.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)

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)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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

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 30k 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 30k 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 30k 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

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

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearContents()

public TranslateTextRequest.Builder clearContents()

Required. The content of the input in string format. We recommend the total content be less than 30k 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

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

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

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

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 BCP-47 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 BCP-47 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.

clone()

public TranslateTextRequest.Builder clone()

Returns

Type	Description
TranslateTextRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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 30k 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 30k 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 30k 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 30k 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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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()

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, 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, 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()

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 BCP-47 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 BCP-47 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 BCP-47 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 BCP-47 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.

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.

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(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

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public TranslateTextRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
TranslateTextRequest.Builder

Overrides

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

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TranslateTextRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
TranslateTextRequest.Builder

Overrides

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

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 30k 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

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

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

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

setSourceLanguageCode(String value)

public TranslateTextRequest.Builder setSourceLanguageCode(String value)

Optional. The BCP-47 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 BCP-47 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 BCP-47 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 BCP-47 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.

setUnknownFields(UnknownFieldSet unknownFields)

public final TranslateTextRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
TranslateTextRequest.Builder

Overrides

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