com.google.cloud.translate.v3beta1.BatchTranslateDocumentRequestOrBuilder Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/translate/v3beta1/translation_service.proto

// Protobuf Java Version: 3.25.2
package com.google.cloud.translate.v3beta1;

public interface BatchTranslateDocumentRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.translation.v3beta1.BatchTranslateDocumentRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. Location to make a regional call.
   *
   * 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) = { ... }
   * 
   *
   * @return The parent.
   */
  java.lang.String getParent();
  /**
   *
   *
   *    * Required. Location to make a regional call.
   *
   * 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) = { ... }
   * 
   *
   * @return The bytes for parent.
   */
  com.google.protobuf.ByteString getParentBytes();

  /**
   *
   *
   *    * Required. The BCP-47 language code of the input document if known, for
   * example, "en-US" or "sr-Latn". 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];
   *
   * @return The sourceLanguageCode.
   */
  java.lang.String getSourceLanguageCode();
  /**
   *
   *
   *    * Required. The BCP-47 language code of the input document if known, for
   * example, "en-US" or "sr-Latn". 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];
   *
   * @return The bytes for sourceLanguageCode.
   */
  com.google.protobuf.ByteString getSourceLanguageCodeBytes();

  /**
   *
   *
   *    * Required. The BCP-47 language code to use for translation of the input
   * document. Specify up to 10 language codes here.
   * 
   *
   * repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return A list containing the targetLanguageCodes.
   */
  java.util.List getTargetLanguageCodesList();
  /**
   *
   *
   *    * Required. The BCP-47 language code to use for translation of the input
   * document. Specify up to 10 language codes here.
   * 
   *
   * repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The count of targetLanguageCodes.
   */
  int getTargetLanguageCodesCount();
  /**
   *
   *
   *    * Required. The BCP-47 language code to use for translation of the input
   * document. Specify up to 10 language codes here.
   * 
   *
   * repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @param index The index of the element to return.
   * @return The targetLanguageCodes at the given index.
   */
  java.lang.String getTargetLanguageCodes(int index);
  /**
   *
   *
   *    * Required. The BCP-47 language code to use for translation of the input
   * document. Specify up to 10 language codes here.
   * 
   *
   * repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @param index The index of the value to return.
   * @return The bytes of the targetLanguageCodes at the given index.
   */
  com.google.protobuf.ByteString getTargetLanguageCodesBytes(int index);

  /**
   *
   *
   *    * Required. Input configurations.
   * The total number of files matched should be <= 100.
   * The total content size to translate should be <= 100M Unicode codepoints.
   * The files must use UTF-8 encoding.
   * 
   *
   * 
   * repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  java.util.List getInputConfigsList();
  /**
   *
   *
   *    * Required. Input configurations.
   * The total number of files matched should be <= 100.
   * The total content size to translate should be <= 100M Unicode codepoints.
   * The files must use UTF-8 encoding.
   * 
   *
   * 
   * repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.translate.v3beta1.BatchDocumentInputConfig getInputConfigs(int index);
  /**
   *
   *
   *    * Required. Input configurations.
   * The total number of files matched should be <= 100.
   * The total content size to translate should be <= 100M Unicode codepoints.
   * The files must use UTF-8 encoding.
   * 
   *
   * 
   * repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  int getInputConfigsCount();
  /**
   *
   *
   *    * Required. Input configurations.
   * The total number of files matched should be <= 100.
   * The total content size to translate should be <= 100M Unicode codepoints.
   * The files must use UTF-8 encoding.
   * 
   *
   * 
   * repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  java.util.List
      getInputConfigsOrBuilderList();
  /**
   *
   *
   *    * Required. Input configurations.
   * The total number of files matched should be <= 100.
   * The total content size to translate should be <= 100M Unicode codepoints.
   * The files must use UTF-8 encoding.
   * 
   *
   * 
   * repeated .google.cloud.translation.v3beta1.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.translate.v3beta1.BatchDocumentInputConfigOrBuilder getInputConfigsOrBuilder(
      int index);

  /**
   *
   *
   *    * 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.v3beta1.BatchDocumentOutputConfig output_config = 5 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return Whether the outputConfig field is set.
   */
  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.v3beta1.BatchDocumentOutputConfig output_config = 5 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The outputConfig.
   */
  com.google.cloud.translate.v3beta1.BatchDocumentOutputConfig 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.v3beta1.BatchDocumentOutputConfig output_config = 5 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.translate.v3beta1.BatchDocumentOutputConfigOrBuilder getOutputConfigOrBuilder();

  /**
   *
   *
   *    * Optional. The models to use for translation. Map's key is target language
   * code. Map's value is the 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 = 6 [(.google.api.field_behavior) = OPTIONAL];
   */
  int getModelsCount();
  /**
   *
   *
   *    * Optional. The models to use for translation. Map's key is target language
   * code. Map's value is the 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 = 6 [(.google.api.field_behavior) = OPTIONAL];
   */
  boolean containsModels(java.lang.String key);
  /** Use {@link #getModelsMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getModels();
  /**
   *
   *
   *    * Optional. The models to use for translation. Map's key is target language
   * code. Map's value is the 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 = 6 [(.google.api.field_behavior) = OPTIONAL];
   */
  java.util.Map getModelsMap();
  /**
   *
   *
   *    * Optional. The models to use for translation. Map's key is target language
   * code. Map's value is the 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 = 6 [(.google.api.field_behavior) = OPTIONAL];
   */
  /* nullable */
  java.lang.String getModelsOrDefault(
      java.lang.String key,
      /* nullable */
      java.lang.String defaultValue);
  /**
   *
   *
   *    * Optional. The models to use for translation. Map's key is target language
   * code. Map's value is the 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 = 6 [(.google.api.field_behavior) = OPTIONAL];
   */
  java.lang.String getModelsOrThrow(java.lang.String key);

  /**
   *
   *
   *    * Optional. Glossaries to be applied. It's keyed by target language code.
   * 
   *
   * 
   * map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  int getGlossariesCount();
  /**
   *
   *
   *    * Optional. Glossaries to be applied. It's keyed by target language code.
   * 
   *
   * 
   * map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  boolean containsGlossaries(java.lang.String key);
  /** Use {@link #getGlossariesMap()} instead. */
  @java.lang.Deprecated
  java.util.Map
      getGlossaries();
  /**
   *
   *
   *    * Optional. Glossaries to be applied. It's keyed by target language code.
   * 
   *
   * 
   * map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  java.util.Map
      getGlossariesMap();
  /**
   *
   *
   *    * Optional. Glossaries to be applied. It's keyed by target language code.
   * 
   *
   * 
   * map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  /* nullable */
  com.google.cloud.translate.v3beta1.TranslateTextGlossaryConfig getGlossariesOrDefault(
      java.lang.String key,
      /* nullable */
      com.google.cloud.translate.v3beta1.TranslateTextGlossaryConfig defaultValue);
  /**
   *
   *
   *    * Optional. Glossaries to be applied. It's keyed by target language code.
   * 
   *
   * 
   * map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.cloud.translate.v3beta1.TranslateTextGlossaryConfig getGlossariesOrThrow(
      java.lang.String key);

  /**
   *
   *
   *    * Optional. File format conversion map to be applied to all input files.
   * Map's key is the original mime_type. Map's value is the target mime_type of
   * translated documents.
   *
   * Supported file format conversion includes:
   * - `application/pdf` to
   *   `application/vnd.openxmlformats-officedocument.wordprocessingml.document`
   *
   * If nothing specified, output files will be in the same format as the
   * original file.
   * 
   *
   * 
   * map<string, string> format_conversions = 8 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  int getFormatConversionsCount();
  /**
   *
   *
   *    * Optional. File format conversion map to be applied to all input files.
   * Map's key is the original mime_type. Map's value is the target mime_type of
   * translated documents.
   *
   * Supported file format conversion includes:
   * - `application/pdf` to
   *   `application/vnd.openxmlformats-officedocument.wordprocessingml.document`
   *
   * If nothing specified, output files will be in the same format as the
   * original file.
   * 
   *
   * 
   * map<string, string> format_conversions = 8 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  boolean containsFormatConversions(java.lang.String key);
  /** Use {@link #getFormatConversionsMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getFormatConversions();
  /**
   *
   *
   *    * Optional. File format conversion map to be applied to all input files.
   * Map's key is the original mime_type. Map's value is the target mime_type of
   * translated documents.
   *
   * Supported file format conversion includes:
   * - `application/pdf` to
   *   `application/vnd.openxmlformats-officedocument.wordprocessingml.document`
   *
   * If nothing specified, output files will be in the same format as the
   * original file.
   * 
   *
   * 
   * map<string, string> format_conversions = 8 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  java.util.Map getFormatConversionsMap();
  /**
   *
   *
   *    * Optional. File format conversion map to be applied to all input files.
   * Map's key is the original mime_type. Map's value is the target mime_type of
   * translated documents.
   *
   * Supported file format conversion includes:
   * - `application/pdf` to
   *   `application/vnd.openxmlformats-officedocument.wordprocessingml.document`
   *
   * If nothing specified, output files will be in the same format as the
   * original file.
   * 
   *
   * 
   * map<string, string> format_conversions = 8 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  /* nullable */
  java.lang.String getFormatConversionsOrDefault(
      java.lang.String key,
      /* nullable */
      java.lang.String defaultValue);
  /**
   *
   *
   *    * Optional. File format conversion map to be applied to all input files.
   * Map's key is the original mime_type. Map's value is the target mime_type of
   * translated documents.
   *
   * Supported file format conversion includes:
   * - `application/pdf` to
   *   `application/vnd.openxmlformats-officedocument.wordprocessingml.document`
   *
   * If nothing specified, output files will be in the same format as the
   * original file.
   * 
   *
   * 
   * map<string, string> format_conversions = 8 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  java.lang.String getFormatConversionsOrThrow(java.lang.String key);

  /**
   *
   *
   *    * Optional. This flag is to support user customized attribution.
   * If not provided, the default is `Machine Translated by Google`.
   * Customized attribution should follow rules in
   * https://cloud.google.com/translate/attribution#attribution_and_logos
   * 
   *
   * string customized_attribution = 10 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The customizedAttribution.
   */
  java.lang.String getCustomizedAttribution();
  /**
   *
   *
   *    * Optional. This flag is to support user customized attribution.
   * If not provided, the default is `Machine Translated by Google`.
   * Customized attribution should follow rules in
   * https://cloud.google.com/translate/attribution#attribution_and_logos
   * 
   *
   * string customized_attribution = 10 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for customizedAttribution.
   */
  com.google.protobuf.ByteString getCustomizedAttributionBytes();

  /**
   *
   *
   *    * Optional. If true, use the text removal server to remove the shadow text on
   * background image for native pdf translation.
   * Shadow removal feature can only be enabled when
   * is_translate_native_pdf_only: false && pdf_native_only: false
   * 
   *
   * bool enable_shadow_removal_native_pdf = 11 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The enableShadowRemovalNativePdf.
   */
  boolean getEnableShadowRemovalNativePdf();

  /**
   *
   *
   *    * Optional. If true, enable auto rotation correction in DVS.
   * 
   *
   * bool enable_rotation_correction = 12 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The enableRotationCorrection.
   */
  boolean getEnableRotationCorrection();
}