Package com.google.cloud.translate.v3beta1

Class BatchTranslateDocumentRequest.Builder

    • Method Detail

      • 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.Builder<BatchTranslateDocumentRequest.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchTranslateDocumentRequest.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<BatchTranslateDocumentRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<BatchTranslateDocumentRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

      • mergeFrom

        public BatchTranslateDocumentRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BatchTranslateDocumentRequest.Builder>
        Throws:
        IOException

      • 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.

      • setParent

        public BatchTranslateDocumentRequest.Builder setParent​(String value)
         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) = { ... }
        Parameters:
        value - The parent to set.
        Returns:
        This builder for chaining.

      • clearParent

        public BatchTranslateDocumentRequest.Builder clearParent()
         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) = { ... }
        Returns:
        This builder for chaining.

      • setParentBytes

        public BatchTranslateDocumentRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for parent to set.
        Returns:
        This builder for chaining.

      • getSourceLanguageCode

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

      • getSourceLanguageCodeBytes

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

      • setSourceLanguageCode

        public BatchTranslateDocumentRequest.Builder setSourceLanguageCode​(String value)
         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];
        Parameters:
        value - The sourceLanguageCode to set.
        Returns:
        This builder for chaining.

      • clearSourceLanguageCode

        public BatchTranslateDocumentRequest.Builder clearSourceLanguageCode()
         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];
        Returns:
        This builder for chaining.

      • setSourceLanguageCodeBytes

        public BatchTranslateDocumentRequest.Builder setSourceLanguageCodeBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for sourceLanguageCode to set.
        Returns:
        This builder for chaining.

      • getTargetLanguageCodesList

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

      • getTargetLanguageCodesCount

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

      • getTargetLanguageCodes

        public 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];
        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 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];
        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.

      • setTargetLanguageCodes

        public BatchTranslateDocumentRequest.Builder setTargetLanguageCodes​(int index,
                                                                    String value)
         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];
        Parameters:
        index - The index to set the value at.
        value - The targetLanguageCodes to set.
        Returns:
        This builder for chaining.

      • addTargetLanguageCodes

        public BatchTranslateDocumentRequest.Builder addTargetLanguageCodes​(String value)
         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];
        Parameters:
        value - The targetLanguageCodes to add.
        Returns:
        This builder for chaining.

      • addAllTargetLanguageCodes

        public BatchTranslateDocumentRequest.Builder addAllTargetLanguageCodes​(Iterable<String> values)
         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];
        Parameters:
        values - The targetLanguageCodes to add.
        Returns:
        This builder for chaining.

      • clearTargetLanguageCodes

        public BatchTranslateDocumentRequest.Builder clearTargetLanguageCodes()
         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];
        Returns:
        This builder for chaining.

      • addTargetLanguageCodesBytes

        public BatchTranslateDocumentRequest.Builder addTargetLanguageCodesBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes of the targetLanguageCodes to add.
        Returns:
        This builder for chaining.

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

      • setInputConfigs

        public BatchTranslateDocumentRequest.Builder setInputConfigs​(int index,
                                                             BatchDocumentInputConfig value)
         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];

      • setInputConfigs

        public BatchTranslateDocumentRequest.Builder setInputConfigs​(int index,
                                                             BatchDocumentInputConfig.Builder builderForValue)
         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];

      • addInputConfigs

        public BatchTranslateDocumentRequest.Builder addInputConfigs​(BatchDocumentInputConfig value)
         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];

      • addInputConfigs

        public BatchTranslateDocumentRequest.Builder addInputConfigs​(int index,
                                                             BatchDocumentInputConfig value)
         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];

      • addInputConfigs

        public BatchTranslateDocumentRequest.Builder addInputConfigs​(BatchDocumentInputConfig.Builder builderForValue)
         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];

      • addInputConfigs

        public BatchTranslateDocumentRequest.Builder addInputConfigs​(int index,
                                                             BatchDocumentInputConfig.Builder builderForValue)
         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];

      • addAllInputConfigs

        public BatchTranslateDocumentRequest.Builder addAllInputConfigs​(Iterable<? extends BatchDocumentInputConfig> values)
         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];

      • clearInputConfigs

        public BatchTranslateDocumentRequest.Builder clearInputConfigs()
         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];

      • removeInputConfigs

        public BatchTranslateDocumentRequest.Builder removeInputConfigs​(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];

      • getInputConfigsBuilder

        public BatchDocumentInputConfig.Builder getInputConfigsBuilder​(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];

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

      • addInputConfigsBuilder

        public BatchDocumentInputConfig.Builder addInputConfigsBuilder()
         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];

      • addInputConfigsBuilder

        public BatchDocumentInputConfig.Builder addInputConfigsBuilder​(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];

      • getInputConfigsBuilderList

        public List<BatchDocumentInputConfig.Builder> getInputConfigsBuilderList()
         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];

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

      • setOutputConfig

        public BatchTranslateDocumentRequest.Builder setOutputConfig​(BatchDocumentOutputConfig value)
         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];

      • setOutputConfig

        public BatchTranslateDocumentRequest.Builder setOutputConfig​(BatchDocumentOutputConfig.Builder builderForValue)
         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];

      • mergeOutputConfig

        public BatchTranslateDocumentRequest.Builder mergeOutputConfig​(BatchDocumentOutputConfig value)
         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];

      • clearOutputConfig

        public BatchTranslateDocumentRequest.Builder clearOutputConfig()
         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];

      • getOutputConfigBuilder

        public BatchDocumentOutputConfig.Builder getOutputConfigBuilder()
         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];

      • 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

      • removeModels

        public BatchTranslateDocumentRequest.Builder removeModels​(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];

      • getMutableModels

        @Deprecated
public Map<String,​String> getMutableModels()
        Deprecated.
        Use alternate mutation accessors instead.

      • putModels

        public BatchTranslateDocumentRequest.Builder putModels​(String key,
                                                       String value)
         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];

      • putAllModels

        public BatchTranslateDocumentRequest.Builder putAllModels​(Map<String,​String> values)
         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];

      • containsGlossaries

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

      • removeGlossaries

        public BatchTranslateDocumentRequest.Builder removeGlossaries​(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];

      • 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

      • removeFormatConversions

        public BatchTranslateDocumentRequest.Builder removeFormatConversions​(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];

      • getMutableFormatConversions

        @Deprecated
public Map<String,​String> getMutableFormatConversions()
        Deprecated.
        Use alternate mutation accessors instead.

      • putFormatConversions

        public BatchTranslateDocumentRequest.Builder putFormatConversions​(String key,
                                                                  String value)
         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];

      • putAllFormatConversions

        public BatchTranslateDocumentRequest.Builder putAllFormatConversions​(Map<String,​String> values)
         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];

      • 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.

      • setCustomizedAttribution

        public BatchTranslateDocumentRequest.Builder setCustomizedAttribution​(String value)
         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];
        Parameters:
        value - The customizedAttribution to set.
        Returns:
        This builder for chaining.

      • clearCustomizedAttribution

        public BatchTranslateDocumentRequest.Builder clearCustomizedAttribution()
         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:
        This builder for chaining.

      • setCustomizedAttributionBytes

        public BatchTranslateDocumentRequest.Builder setCustomizedAttributionBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for customizedAttribution to set.
        Returns:
        This builder for chaining.

      • 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.

      • setEnableShadowRemovalNativePdf

        public BatchTranslateDocumentRequest.Builder setEnableShadowRemovalNativePdf​(boolean value)
         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];
        Parameters:
        value - The enableShadowRemovalNativePdf to set.
        Returns:
        This builder for chaining.

      • clearEnableShadowRemovalNativePdf

        public BatchTranslateDocumentRequest.Builder clearEnableShadowRemovalNativePdf()
         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];
        Returns:
        This builder for chaining.

      • 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.

      • setEnableRotationCorrection

        public BatchTranslateDocumentRequest.Builder setEnableRotationCorrection​(boolean value)
         Optional. If true, enable auto rotation correction in DVS.
        bool enable_rotation_correction = 12 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The enableRotationCorrection to set.
        Returns:
        This builder for chaining.

      • clearEnableRotationCorrection

        public BatchTranslateDocumentRequest.Builder clearEnableRotationCorrection()
         Optional. If true, enable auto rotation correction in DVS.
        bool enable_rotation_correction = 12 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.