Package com.google.cloud.translate.v3

Class BatchTranslateDocumentRequest

    • Field Detail

      • SOURCE_LANGUAGE_CODE_FIELD_NUMBER

        public static final int SOURCE_LANGUAGE_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_LANGUAGE_CODES_FIELD_NUMBER

        public static final int TARGET_LANGUAGE_CODES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INPUT_CONFIGS_FIELD_NUMBER

        public static final int INPUT_CONFIGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OUTPUT_CONFIG_FIELD_NUMBER

        public static final int OUTPUT_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GLOSSARIES_FIELD_NUMBER

        public static final int GLOSSARIES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FORMAT_CONVERSIONS_FIELD_NUMBER

        public static final int FORMAT_CONVERSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CUSTOMIZED_ATTRIBUTION_FIELD_NUMBER

        public static final int CUSTOMIZED_ATTRIBUTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_SHADOW_REMOVAL_NATIVE_PDF_FIELD_NUMBER

        public static final int ENABLE_SHADOW_REMOVAL_NATIVE_PDF_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_ROTATION_CORRECTION_FIELD_NUMBER

        public static final int ENABLE_ROTATION_CORRECTION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getParent

        public 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) = { ... }
        Specified by:
        getParent in interface BatchTranslateDocumentRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         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) = { ... }
        Specified by:
        getParentBytes in interface BatchTranslateDocumentRequestOrBuilder
        Returns:
        The bytes for parent.

      • getSourceLanguageCode

        public String getSourceLanguageCode()
         Required. The ISO-639 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];
        Specified by:
        getSourceLanguageCode in interface BatchTranslateDocumentRequestOrBuilder
        Returns:
        The sourceLanguageCode.

      • getSourceLanguageCodeBytes

        public com.google.protobuf.ByteString getSourceLanguageCodeBytes()
         Required. The ISO-639 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];
        Specified by:
        getSourceLanguageCodeBytes in interface BatchTranslateDocumentRequestOrBuilder
        Returns:
        The bytes for sourceLanguageCode.

      • getTargetLanguageCodesList

        public com.google.protobuf.ProtocolStringList getTargetLanguageCodesList()
         Required. The ISO-639 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];
        Specified by:
        getTargetLanguageCodesList in interface BatchTranslateDocumentRequestOrBuilder
        Returns:
        A list containing the targetLanguageCodes.

      • getTargetLanguageCodesCount

        public int getTargetLanguageCodesCount()
         Required. The ISO-639 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];
        Specified by:
        getTargetLanguageCodesCount in interface BatchTranslateDocumentRequestOrBuilder
        Returns:
        The count of targetLanguageCodes.

      • getTargetLanguageCodes

        public String getTargetLanguageCodes​(int index)
         Required. The ISO-639 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];
        Specified by:
        getTargetLanguageCodes in interface BatchTranslateDocumentRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The targetLanguageCodes at the given index.

      • getTargetLanguageCodesBytes

        public com.google.protobuf.ByteString getTargetLanguageCodesBytes​(int index)
         Required. The ISO-639 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];
        Specified by:
        getTargetLanguageCodesBytes in interface BatchTranslateDocumentRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the targetLanguageCodes at the given index.

      • getInputConfigsList

        public List<BatchDocumentInputConfig> 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.v3.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputConfigsList in interface BatchTranslateDocumentRequestOrBuilder

      • getInputConfigsOrBuilderList

        public List<? extends BatchDocumentInputConfigOrBuilder> 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.v3.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputConfigsOrBuilderList in interface BatchTranslateDocumentRequestOrBuilder

      • getInputConfigsCount

        public 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.v3.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputConfigsCount in interface BatchTranslateDocumentRequestOrBuilder

      • getInputConfigs

        public 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.v3.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputConfigs in interface BatchTranslateDocumentRequestOrBuilder

      • getInputConfigsOrBuilder

        public BatchDocumentInputConfigOrBuilder getInputConfigsOrBuilder​(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.v3.BatchDocumentInputConfig input_configs = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputConfigsOrBuilder in interface BatchTranslateDocumentRequestOrBuilder

      • hasOutputConfig

        public 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.BatchDocumentOutputConfig output_config = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasOutputConfig in interface BatchTranslateDocumentRequestOrBuilder
        Returns:
        Whether the outputConfig field is set.

      • getOutputConfig

        public 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.v3.BatchDocumentOutputConfig output_config = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getOutputConfig in interface BatchTranslateDocumentRequestOrBuilder
        Returns:
        The outputConfig.

      • getModelsCount

        public int getModelsCount()
        Description copied from interface: BatchTranslateDocumentRequestOrBuilder
         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];
        Specified by:
        getModelsCount in interface BatchTranslateDocumentRequestOrBuilder

      • containsModels

        public boolean containsModels​(String key)
         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];
        Specified by:
        containsModels in interface BatchTranslateDocumentRequestOrBuilder

      • getModelsMap

        public Map<String,​String> 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];
        Specified by:
        getModelsMap in interface BatchTranslateDocumentRequestOrBuilder

      • getModelsOrDefault

        public String getModelsOrDefault​(String key,
                                 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];
        Specified by:
        getModelsOrDefault in interface BatchTranslateDocumentRequestOrBuilder

      • getModelsOrThrow

        public String getModelsOrThrow​(String key)
         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];
        Specified by:
        getModelsOrThrow in interface BatchTranslateDocumentRequestOrBuilder

      • containsGlossaries

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

      • getFormatConversionsCount

        public int getFormatConversionsCount()
        Description copied from interface: BatchTranslateDocumentRequestOrBuilder
         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];
        Specified by:
        getFormatConversionsCount in interface BatchTranslateDocumentRequestOrBuilder

      • containsFormatConversions

        public boolean containsFormatConversions​(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];
        Specified by:
        containsFormatConversions in interface BatchTranslateDocumentRequestOrBuilder

      • getFormatConversionsMap

        public Map<String,​String> 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];
        Specified by:
        getFormatConversionsMap in interface BatchTranslateDocumentRequestOrBuilder

      • getFormatConversionsOrDefault

        public String getFormatConversionsOrDefault​(String key,
                                            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];
        Specified by:
        getFormatConversionsOrDefault in interface BatchTranslateDocumentRequestOrBuilder

      • getFormatConversionsOrThrow

        public String getFormatConversionsOrThrow​(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];
        Specified by:
        getFormatConversionsOrThrow in interface BatchTranslateDocumentRequestOrBuilder

      • getCustomizedAttribution

        public 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];
        Specified by:
        getCustomizedAttribution in interface BatchTranslateDocumentRequestOrBuilder
        Returns:
        The customizedAttribution.

      • getCustomizedAttributionBytes

        public com.google.protobuf.ByteString getCustomizedAttributionBytes()
         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];
        Specified by:
        getCustomizedAttributionBytes in interface BatchTranslateDocumentRequestOrBuilder
        Returns:
        The bytes for customizedAttribution.

      • getEnableShadowRemovalNativePdf

        public boolean getEnableShadowRemovalNativePdf()
         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];
        Specified by:
        getEnableShadowRemovalNativePdf in interface BatchTranslateDocumentRequestOrBuilder
        Returns:
        The enableShadowRemovalNativePdf.

      • getEnableRotationCorrection

        public boolean getEnableRotationCorrection()
         Optional. If true, enable auto rotation correction in DVS.
        bool enable_rotation_correction = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEnableRotationCorrection in interface BatchTranslateDocumentRequestOrBuilder
        Returns:
        The enableRotationCorrection.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static BatchTranslateDocumentRequest parseFrom​(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchTranslateDocumentRequest parseFrom​(ByteBuffer data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchTranslateDocumentRequest parseFrom​(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchTranslateDocumentRequest parseFrom​(com.google.protobuf.ByteString data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchTranslateDocumentRequest parseFrom​(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchTranslateDocumentRequest parseFrom​(byte[] data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public BatchTranslateDocumentRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public BatchTranslateDocumentRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected BatchTranslateDocumentRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<BatchTranslateDocumentRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public BatchTranslateDocumentRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder