Package com.google.cloud.translate.v3beta1

Class TranslateDocumentRequest

  • All Implemented Interfaces:
    TranslateDocumentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class TranslateDocumentRequest
extends com.google.protobuf.GeneratedMessageV3
implements TranslateDocumentRequestOrBuilder
     A document translation request.
    Protobuf type google.cloud.translation.v3beta1.TranslateDocumentRequest
    See Also:
    Serialized Form

    • Field Detail

      • SOURCE_LANGUAGE_CODE_FIELD_NUMBER

        public static final int SOURCE_LANGUAGE_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_LANGUAGE_CODE_FIELD_NUMBER

        public static final int TARGET_LANGUAGE_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCUMENT_INPUT_CONFIG_FIELD_NUMBER

        public static final int DOCUMENT_INPUT_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER

        public static final int DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GLOSSARY_CONFIG_FIELD_NUMBER

        public static final int GLOSSARY_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CUSTOMIZED_ATTRIBUTION_FIELD_NUMBER

        public static final int CUSTOMIZED_ATTRIBUTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IS_TRANSLATE_NATIVE_PDF_ONLY_FIELD_NUMBER

        public static final int IS_TRANSLATE_NATIVE_PDF_ONLY_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}`.

 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];
        Specified by:
        getParent in interface TranslateDocumentRequestOrBuilder
        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}`.

 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];
        Specified by:
        getParentBytes in interface TranslateDocumentRequestOrBuilder
        Returns:
        The bytes for parent.

      • getSourceLanguageCode

        public 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];
        Specified by:
        getSourceLanguageCode in interface TranslateDocumentRequestOrBuilder
        Returns:
        The sourceLanguageCode.

      • getSourceLanguageCodeBytes

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

      • getTargetLanguageCode

        public 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];
        Specified by:
        getTargetLanguageCode in interface TranslateDocumentRequestOrBuilder
        Returns:
        The targetLanguageCode.

      • getTargetLanguageCodeBytes

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

      • hasDocumentInputConfig

        public boolean hasDocumentInputConfig()
         Required. Input configurations.
        .google.cloud.translation.v3beta1.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasDocumentInputConfig in interface TranslateDocumentRequestOrBuilder
        Returns:
        Whether the documentInputConfig field is set.

      • hasDocumentOutputConfig

        public 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];
        Specified by:
        hasDocumentOutputConfig in interface TranslateDocumentRequestOrBuilder
        Returns:
        Whether the documentOutputConfig field is set.

      • getDocumentOutputConfig

        public 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];
        Specified by:
        getDocumentOutputConfig in interface TranslateDocumentRequestOrBuilder
        Returns:
        The documentOutputConfig.

      • getDocumentOutputConfigOrBuilder

        public 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.v3beta1.DocumentOutputConfig document_output_config = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDocumentOutputConfigOrBuilder in interface TranslateDocumentRequestOrBuilder

      • getModel

        public 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];
        Specified by:
        getModel in interface TranslateDocumentRequestOrBuilder
        Returns:
        The model.

      • getModelBytes

        public 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];
        Specified by:
        getModelBytes in interface TranslateDocumentRequestOrBuilder
        Returns:
        The bytes for model.

      • hasGlossaryConfig

        public 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];
        Specified by:
        hasGlossaryConfig in interface TranslateDocumentRequestOrBuilder
        Returns:
        Whether the glossaryConfig field is set.

      • getGlossaryConfig

        public 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];
        Specified by:
        getGlossaryConfig in interface TranslateDocumentRequestOrBuilder
        Returns:
        The glossaryConfig.

      • getGlossaryConfigOrBuilder

        public 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.v3beta1.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getGlossaryConfigOrBuilder in interface TranslateDocumentRequestOrBuilder

      • getLabelsCount

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

      • containsLabels

        public 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];
        Specified by:
        containsLabels in interface TranslateDocumentRequestOrBuilder

      • getLabelsMap

        public 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];
        Specified by:
        getLabelsMap in interface TranslateDocumentRequestOrBuilder

      • getLabelsOrDefault

        public 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];
        Specified by:
        getLabelsOrDefault in interface TranslateDocumentRequestOrBuilder

      • getLabelsOrThrow

        public 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];
        Specified by:
        getLabelsOrThrow in interface TranslateDocumentRequestOrBuilder

      • 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 TranslateDocumentRequestOrBuilder
        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 TranslateDocumentRequestOrBuilder
        Returns:
        The bytes for customizedAttribution.

      • getIsTranslateNativePdfOnly

        public 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];
        Specified by:
        getIsTranslateNativePdfOnly in interface TranslateDocumentRequestOrBuilder
        Returns:
        The isTranslateNativePdfOnly.

      • 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 = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEnableShadowRemovalNativePdf in interface TranslateDocumentRequestOrBuilder
        Returns:
        The enableShadowRemovalNativePdf.

      • getEnableRotationCorrection

        public boolean getEnableRotationCorrection()
         Optional. If true, enable auto rotation correction in DVS.
        bool enable_rotation_correction = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEnableRotationCorrection in interface TranslateDocumentRequestOrBuilder
        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 TranslateDocumentRequest parseFrom​(ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<TranslateDocumentRequest> 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 TranslateDocumentRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder