Package com.google.cloud.translate.v3

Interface BatchTranslateTextRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BatchTranslateTextRequest, BatchTranslateTextRequest.Builder
@Generated public interface BatchTranslateTextRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getParent

      String getParent()
       Required. Location to make a call. Must refer to a caller's project.

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

 The `global` location is not supported for batch translation.

 Only AutoML Translation models or glossaries within the same region (have
 the same location-id) can be used, otherwise an INVALID_ARGUMENT (400)
 error is returned.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. Location to make a call. Must refer to a caller's project.

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

 The `global` location is not supported for batch translation.

 Only AutoML Translation models or glossaries within the same region (have
 the same location-id) can be used, otherwise an INVALID_ARGUMENT (400)
 error is returned.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getSourceLanguageCode

      String getSourceLanguageCode()
       Required. Source language code. Supported language codes are listed in
 [Language
 Support](https://cloud.google.com/translate/docs/languages).
      string source_language_code = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The sourceLanguageCode.

    • getSourceLanguageCodeBytes

      com.google.protobuf.ByteString getSourceLanguageCodeBytes()
       Required. Source language code. Supported language codes are listed in
 [Language
 Support](https://cloud.google.com/translate/docs/languages).
      string source_language_code = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for sourceLanguageCode.

    • getTargetLanguageCodesList

      List<String> getTargetLanguageCodesList()
       Required. Specify up to 10 language codes here. Supported language codes
 are listed in [Language
 Support](https://cloud.google.com/translate/docs/languages).
      repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      A list containing the targetLanguageCodes.

    • getTargetLanguageCodesCount

      int getTargetLanguageCodesCount()
       Required. Specify up to 10 language codes here. Supported language codes
 are listed in [Language
 Support](https://cloud.google.com/translate/docs/languages).
      repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The count of targetLanguageCodes.

    • getTargetLanguageCodes

      String getTargetLanguageCodes(int index)
       Required. Specify up to 10 language codes here. Supported language codes
 are listed in [Language
 Support](https://cloud.google.com/translate/docs/languages).
      repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      index - The index of the element to return.
      Returns:
      The targetLanguageCodes at the given index.

    • getTargetLanguageCodesBytes

      com.google.protobuf.ByteString getTargetLanguageCodesBytes(int index)
       Required. Specify up to 10 language codes here. Supported language codes
 are listed in [Language
 Support](https://cloud.google.com/translate/docs/languages).
      repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the targetLanguageCodes at the given index.

    • getModelsCount

      int getModelsCount()
       Optional. The models to use for translation. Map's key is target language
 code. Map's value is model name. Value can be a built-in general model,
 or an AutoML Translation model.

 The value format depends on model type:

 - AutoML Translation models:
 `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`

 - General (built-in) models:
 `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,


 If the map is empty or a specific model is
 not requested for a language pair, then default google model (nmt) is used.
      map<string, string> models = 4 [(.google.api.field_behavior) = OPTIONAL];

    • containsModels

      boolean containsModels(String key)
       Optional. The models to use for translation. Map's key is target language
 code. Map's value is model name. Value can be a built-in general model,
 or an AutoML Translation model.

 The value format depends on model type:

 - AutoML Translation models:
 `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`

 - General (built-in) models:
 `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,


 If the map is empty or a specific model is
 not requested for a language pair, then default google model (nmt) is used.
      map<string, string> models = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getModels

      @Deprecated Map<String,String> getModels()
      Deprecated.
      Use getModelsMap() instead.

    • getModelsMap

      Map<String,String> getModelsMap()
       Optional. The models to use for translation. Map's key is target language
 code. Map's value is model name. Value can be a built-in general model,
 or an AutoML Translation model.

 The value format depends on model type:

 - AutoML Translation models:
 `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`

 - General (built-in) models:
 `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,


 If the map is empty or a specific model is
 not requested for a language pair, then default google model (nmt) is used.
      map<string, string> models = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getModelsOrDefault

      String getModelsOrDefault(String key, String defaultValue)
       Optional. The models to use for translation. Map's key is target language
 code. Map's value is model name. Value can be a built-in general model,
 or an AutoML Translation model.

 The value format depends on model type:

 - AutoML Translation models:
 `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`

 - General (built-in) models:
 `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,


 If the map is empty or a specific model is
 not requested for a language pair, then default google model (nmt) is used.
      map<string, string> models = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getModelsOrThrow

      String getModelsOrThrow(String key)
       Optional. The models to use for translation. Map's key is target language
 code. Map's value is model name. Value can be a built-in general model,
 or an AutoML Translation model.

 The value format depends on model type:

 - AutoML Translation models:
 `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`

 - General (built-in) models:
 `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,


 If the map is empty or a specific model is
 not requested for a language pair, then default google model (nmt) is used.
      map<string, string> models = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getInputConfigsList

      List<InputConfig> getInputConfigsList()
       Required. Input configurations.
 The total number of files matched should be <= 100.
 The total content size should be <= 100M Unicode codepoints.
 The files must use UTF-8 encoding.
      repeated .google.cloud.translation.v3.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];

    • getInputConfigs

      InputConfig getInputConfigs(int index)
       Required. Input configurations.
 The total number of files matched should be <= 100.
 The total content size should be <= 100M Unicode codepoints.
 The files must use UTF-8 encoding.
      repeated .google.cloud.translation.v3.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];

    • getInputConfigsCount

      int getInputConfigsCount()
       Required. Input configurations.
 The total number of files matched should be <= 100.
 The total content size should be <= 100M Unicode codepoints.
 The files must use UTF-8 encoding.
      repeated .google.cloud.translation.v3.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];

    • getInputConfigsOrBuilderList

      List<? extends InputConfigOrBuilder> getInputConfigsOrBuilderList()
       Required. Input configurations.
 The total number of files matched should be <= 100.
 The total content size should be <= 100M Unicode codepoints.
 The files must use UTF-8 encoding.
      repeated .google.cloud.translation.v3.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];

    • getInputConfigsOrBuilder

      InputConfigOrBuilder getInputConfigsOrBuilder(int index)
       Required. Input configurations.
 The total number of files matched should be <= 100.
 The total content size should be <= 100M Unicode codepoints.
 The files must use UTF-8 encoding.
      repeated .google.cloud.translation.v3.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];

    • hasOutputConfig

      boolean hasOutputConfig()
       Required. Output configuration.
 If 2 input configs match to the same file (that is, same input path),
 we don't generate output for duplicate inputs.
      .google.cloud.translation.v3.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the outputConfig field is set.

    • getOutputConfig

      OutputConfig getOutputConfig()
       Required. Output configuration.
 If 2 input configs match to the same file (that is, same input path),
 we don't generate output for duplicate inputs.
      .google.cloud.translation.v3.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The outputConfig.

    • getOutputConfigOrBuilder

      OutputConfigOrBuilder getOutputConfigOrBuilder()
       Required. Output configuration.
 If 2 input configs match to the same file (that is, same input path),
 we don't generate output for duplicate inputs.
      .google.cloud.translation.v3.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

    • getGlossariesCount

      int getGlossariesCount()
       Optional. Glossaries to be applied for translation.
 It's keyed by target language code.
      map<string, .google.cloud.translation.v3.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];

    • containsGlossaries

      boolean containsGlossaries(String key)
       Optional. Glossaries to be applied for translation.
 It's keyed by target language code.
      map<string, .google.cloud.translation.v3.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getGlossaries

      @Deprecated Map<String,TranslateTextGlossaryConfig> getGlossaries()
      Deprecated.
      Use getGlossariesMap() instead.

    • getGlossariesMap

      Map<String,TranslateTextGlossaryConfig> getGlossariesMap()
       Optional. Glossaries to be applied for translation.
 It's keyed by target language code.
      map<string, .google.cloud.translation.v3.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getGlossariesOrDefault

      TranslateTextGlossaryConfig getGlossariesOrDefault(String key, TranslateTextGlossaryConfig defaultValue)
       Optional. Glossaries to be applied for translation.
 It's keyed by target language code.
      map<string, .google.cloud.translation.v3.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getGlossariesOrThrow

      TranslateTextGlossaryConfig getGlossariesOrThrow(String key)
       Optional. Glossaries to be applied for translation.
 It's keyed by target language code.
      map<string, .google.cloud.translation.v3.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];

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