public final class TranslateTextRequest extends GeneratedMessageV3 implements TranslateTextRequestOrBuilder
The request message for synchronous translation.
Protobuf type google.cloud.translation.v3.TranslateTextRequest
Static Fields
CONTENTS_FIELD_NUMBER
public static final int CONTENTS_FIELD_NUMBER
Field Value
GLOSSARY_CONFIG_FIELD_NUMBER
public static final int GLOSSARY_CONFIG_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
MIME_TYPE_FIELD_NUMBER
public static final int MIME_TYPE_FIELD_NUMBER
Field Value
MODEL_FIELD_NUMBER
public static final int MODEL_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
SOURCE_LANGUAGE_CODE_FIELD_NUMBER
public static final int SOURCE_LANGUAGE_CODE_FIELD_NUMBER
Field Value
TARGET_LANGUAGE_CODE_FIELD_NUMBER
public static final int TARGET_LANGUAGE_CODE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static TranslateTextRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static TranslateTextRequest.Builder newBuilder()
Returns
newBuilder(TranslateTextRequest prototype)
public static TranslateTextRequest.Builder newBuilder(TranslateTextRequest prototype)
Parameter
Returns
parseDelimitedFrom(InputStream input)
public static TranslateTextRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TranslateTextRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TranslateTextRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TranslateTextRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TranslateTextRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TranslateTextRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static TranslateTextRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TranslateTextRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static TranslateTextRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TranslateTextRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TranslateTextRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TranslateTextRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<TranslateTextRequest> parser()
Returns
Methods
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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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];
| 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];
| 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];
| 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];
getDefaultInstanceForType()
public TranslateTextRequest getDefaultInstanceForType()
Returns
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];
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];
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
Optional. The labels with user-defined metadata for the request.
Label keys and values can be no longer than 63 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
Label values are optional. Label keys must start with a letter.
See https://cloud.google.com/translate/docs/advanced/labels for more
information.
map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. The labels with user-defined metadata for the request.
Label keys and values can be no longer than 63 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
Label values are optional. Label keys must start with a letter.
See https://cloud.google.com/translate/docs/advanced/labels for more
information.
map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. The labels with user-defined metadata for the request.
Label keys and values can be no longer than 63 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
Label values are optional. Label keys must start with a letter.
See https://cloud.google.com/translate/docs/advanced/labels for more
information.
map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional. The labels with user-defined metadata for the request.
Label keys and values can be no longer than 63 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
Label values are optional. Label keys must start with a letter.
See https://cloud.google.com/translate/docs/advanced/labels for more
information.
map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
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];
| 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];
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];
| 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];
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) = { ... }
| 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) = { ... }
getParserForType()
public Parser<TranslateTextRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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];
| 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];
| 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];
| 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];
| Type | Description |
| ByteString | The bytes for targetLanguageCode.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
| Type | Description |
| boolean | Whether the glossaryConfig field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public TranslateTextRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TranslateTextRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public TranslateTextRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
