Package com.google.cloud.translate.v3

Interface TranslateDocumentRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    TranslateDocumentRequest, TranslateDocumentRequest.Builder
    public interface TranslateDocumentRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getParent

        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` 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 the same
 location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         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` 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 the same
 location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for parent.

      • getSourceLanguageCode

        String getSourceLanguageCode()
         Optional. 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. 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];
        Returns:
        The sourceLanguageCode.

      • getSourceLanguageCodeBytes

        com.google.protobuf.ByteString getSourceLanguageCodeBytes()
         Optional. 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. 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];
        Returns:
        The bytes for sourceLanguageCode.

      • getTargetLanguageCode

        String getTargetLanguageCode()
         Required. The ISO-639 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];
        Returns:
        The targetLanguageCode.

      • getTargetLanguageCodeBytes

        com.google.protobuf.ByteString getTargetLanguageCodeBytes()
         Required. The ISO-639 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];
        Returns:
        The bytes for targetLanguageCode.

      • hasDocumentInputConfig

        boolean hasDocumentInputConfig()
         Required. Input configurations.
        .google.cloud.translation.v3.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the documentInputConfig field is set.

      • getDocumentInputConfig

        DocumentInputConfig getDocumentInputConfig()
         Required. Input configurations.
        .google.cloud.translation.v3.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The documentInputConfig.

      • getDocumentInputConfigOrBuilder

        DocumentInputConfigOrBuilder getDocumentInputConfigOrBuilder()
         Required. Input configurations.
        .google.cloud.translation.v3.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];

      • hasDocumentOutputConfig

        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.v3.DocumentOutputConfig document_output_config = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the documentOutputConfig field is set.

      • getDocumentOutputConfig

        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.v3.DocumentOutputConfig document_output_config = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The documentOutputConfig.

      • getDocumentOutputConfigOrBuilder

        DocumentOutputConfigOrBuilder getDocumentOutputConfigOrBuilder()
         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.v3.DocumentOutputConfig document_output_config = 5 [(.google.api.field_behavior) = OPTIONAL];

      • 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`,


 If not provided, the default Google model (NMT) will be used for
 translation.
        string model = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The model.

      • getModelBytes

        com.google.protobuf.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`,


 If not provided, the default Google model (NMT) will be used for
 translation.
        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 = 8 [(.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 = 8 [(.google.api.field_behavior) = OPTIONAL];

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

      • getCustomizedAttribution

        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];
        Returns:
        The customizedAttribution.

      • getCustomizedAttributionBytes

        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];
        Returns:
        The bytes for customizedAttribution.

      • getIsTranslateNativePdfOnly

        boolean getIsTranslateNativePdfOnly()
         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];
        Returns:
        The isTranslateNativePdfOnly.

      • getEnableShadowRemovalNativePdf

        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 = 12 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enableShadowRemovalNativePdf.

      • getEnableRotationCorrection

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