/*
* 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 TranslateDocumentRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.translation.v3beta1.TranslateDocumentRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. Location to make a regional call.
*
* Format: `projects/{project-number-or-id}/locations/{location-id}`.
*
* For global calls, use `projects/{project-number-or-id}/locations/global`.
*
* Non-global location is required for requests using AutoML models or custom
* glossaries.
*
* Models and glossaries must be within the same region (have the same
* location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
*
*
* string parent = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The parent.
*/
java.lang.String getParent();
/**
*
*
*
* Required. Location to make a regional call.
*
* Format: `projects/{project-number-or-id}/locations/{location-id}`.
*
* For global calls, use `projects/{project-number-or-id}/locations/global`.
*
* Non-global location is required for requests using AutoML models or custom
* glossaries.
*
* Models and glossaries must be within the same region (have the same
* location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
*
*
* string parent = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for parent.
*/
com.google.protobuf.ByteString getParentBytes();
/**
*
*
*
* Optional. 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. If the source language isn't specified, the API attempts
* to identify the source language automatically and returns the source
* language within the response. Source language must be specified if the
* request contains a glossary or a custom model.
*
*
* string source_language_code = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The sourceLanguageCode.
*/
java.lang.String getSourceLanguageCode();
/**
*
*
*
* Optional. 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. If the source language isn't specified, the API attempts
* to identify the source language automatically and returns the source
* language within the response. Source language must be specified if the
* request contains a glossary or a custom model.
*
*
* string source_language_code = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for sourceLanguageCode.
*/
com.google.protobuf.ByteString getSourceLanguageCodeBytes();
/**
*
*
*
* Required. The BCP-47 language code to use for translation of the input
* document, set to one of the language codes listed in Language Support.
*
*
* string target_language_code = 3 [(.google.api.field_behavior) = REQUIRED];
*
* @return The targetLanguageCode.
*/
java.lang.String getTargetLanguageCode();
/**
*
*
*
* Required. The BCP-47 language code to use for translation of the input
* document, set to one of the language codes listed in Language Support.
*
*
* string target_language_code = 3 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for targetLanguageCode.
*/
com.google.protobuf.ByteString getTargetLanguageCodeBytes();
/**
*
*
*
* Required. Input configurations.
*
*
*
* .google.cloud.translation.v3beta1.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the documentInputConfig field is set.
*/
boolean hasDocumentInputConfig();
/**
*
*
*
* Required. Input configurations.
*
*
*
* .google.cloud.translation.v3beta1.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The documentInputConfig.
*/
com.google.cloud.translate.v3beta1.DocumentInputConfig getDocumentInputConfig();
/**
*
*
*
* Required. Input configurations.
*
*
*
* .google.cloud.translation.v3beta1.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.translate.v3beta1.DocumentInputConfigOrBuilder getDocumentInputConfigOrBuilder();
/**
*
*
*
* Optional. Output configurations.
* Defines if the output file should be stored within Cloud Storage as well
* as the desired output format. If not provided the translated file will
* only be returned through a byte-stream and its output mime type will be
* the same as the input file's mime type.
*
*
*
* .google.cloud.translation.v3beta1.DocumentOutputConfig document_output_config = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the documentOutputConfig field is set.
*/
boolean hasDocumentOutputConfig();
/**
*
*
*
* Optional. Output configurations.
* Defines if the output file should be stored within Cloud Storage as well
* as the desired output format. If not provided the translated file will
* only be returned through a byte-stream and its output mime type will be
* the same as the input file's mime type.
*
*
*
* .google.cloud.translation.v3beta1.DocumentOutputConfig document_output_config = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The documentOutputConfig.
*/
com.google.cloud.translate.v3beta1.DocumentOutputConfig getDocumentOutputConfig();
/**
*
*
*
* Optional. Output configurations.
* Defines if the output file should be stored within Cloud Storage as well
* as the desired output format. If not provided the translated file will
* only be returned through a byte-stream and its output mime type will be
* the same as the input file's mime type.
*
*
*
* .google.cloud.translation.v3beta1.DocumentOutputConfig document_output_config = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.translate.v3beta1.DocumentOutputConfigOrBuilder
getDocumentOutputConfigOrBuilder();
/**
*
*
*
* 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`,
*
*
* If not provided, the default Google model (NMT) will be used for
* translation.
*
*
* string model = 6 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The model.
*/
java.lang.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`,
*
*
* If not provided, the default Google model (NMT) will be used for
* translation.
*
*
* string model = 6 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for model.
*/
com.google.protobuf.ByteString getModelBytes();
/**
*
*
*
* 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.v3beta1.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the glossaryConfig field is set.
*/
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.v3beta1.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The glossaryConfig.
*/
com.google.cloud.translate.v3beta1.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.v3beta1.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.translate.v3beta1.TranslateTextGlossaryConfigOrBuilder
getGlossaryConfigOrBuilder();
/**
*
*
*
* 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 = 8 [(.google.api.field_behavior) = OPTIONAL];
*/
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 = 8 [(.google.api.field_behavior) = OPTIONAL];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* 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 = 8 [(.google.api.field_behavior) = OPTIONAL];
*/
java.util.Map 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 = 8 [(.google.api.field_behavior) = OPTIONAL];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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 = 8 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrThrow(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. is_translate_native_pdf_only field for external customers.
* If true, the page limit of online native pdf translation is 300 and only
* native pdf pages will be translated.
*
*
* bool is_translate_native_pdf_only = 11 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The isTranslateNativePdfOnly.
*/
boolean getIsTranslateNativePdfOnly();
/**
*
*
*
* 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 = 12 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The enableShadowRemovalNativePdf.
*/
boolean getEnableShadowRemovalNativePdf();
/**
*
*
*
* Optional. If true, enable auto rotation correction in DVS.
*
*
* bool enable_rotation_correction = 13 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The enableRotationCorrection.
*/
boolean getEnableRotationCorrection();
}
