com.google.cloud.translate.v3

Interface TranslateTextRequestOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

TranslateTextRequest, TranslateTextRequest.Builder

public interface TranslateTextRequestOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
String	getContents(int index) Required.
ByteString	getContentsBytes(int index) Required.
int	getContentsCount() Required.
List<String>	getContentsList() Required.
TranslateTextGlossaryConfig	getGlossaryConfig() Optional.
TranslateTextGlossaryConfigOrBuilder	getGlossaryConfigOrBuilder() Optional.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
String	getMimeType() Optional.
ByteString	getMimeTypeBytes() Optional.
String	getModel() Optional.
ByteString	getModelBytes() Optional.
String	getParent() Required.
ByteString	getParentBytes() Required.
String	getSourceLanguageCode() Optional.
ByteString	getSourceLanguageCodeBytes() Optional.
String	getTargetLanguageCode() Required.
ByteString	getTargetLanguageCodeBytes() Required.
boolean	hasGlossaryConfig() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getContentsList

List<String> 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:

A list containing the contents.

getContentsCount

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:

The count of contents.

getContents

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

Parameters:

index - The index of the element to return.

Returns:

The contents at the given index.

getContentsBytes

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

Parameters:

index - The index of the value to return.

Returns:

The bytes of the contents at the given index.

getMimeType

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:

The mimeType.

getMimeTypeBytes

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:

The bytes for mimeType.

getSourceLanguageCode

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:

The sourceLanguageCode.

getSourceLanguageCodeBytes

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:

The bytes for sourceLanguageCode.

getTargetLanguageCode

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:

The targetLanguageCode.

getTargetLanguageCodeBytes

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:

The bytes for targetLanguageCode.

getParent

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:

The parent.

getParentBytes

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:

The bytes for parent.

getModel

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:

The model.

getModelBytes

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:

The bytes for model.

hasGlossaryConfig

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:

Whether the glossaryConfig field is set.

getGlossaryConfig

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:

The glossaryConfig.

getGlossaryConfigOrBuilder

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

getLabelsCount

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

containsLabels

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

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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