Package com.google.cloud.translate.v3

Class BatchTranslateTextRequest

  • All Implemented Interfaces:
    BatchTranslateTextRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class BatchTranslateTextRequest
extends com.google.protobuf.GeneratedMessageV3
implements BatchTranslateTextRequestOrBuilder
     The batch translation request.
    Protobuf type google.cloud.translation.v3.BatchTranslateTextRequest
    See Also:
    Serialized Form

    • 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 call. Must refer to a caller's project.

 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 BatchTranslateTextRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. Location to make a call. Must refer to a caller's project.

 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 BatchTranslateTextRequestOrBuilder
        Returns:
        The bytes for parent.

      • getSourceLanguageCodeBytes

        public com.google.protobuf.ByteString getSourceLanguageCodeBytes()
         Required. Source language code.
        string source_language_code = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getSourceLanguageCodeBytes in interface BatchTranslateTextRequestOrBuilder
        Returns:
        The bytes for sourceLanguageCode.

      • getTargetLanguageCodesList

        public com.google.protobuf.ProtocolStringList getTargetLanguageCodesList()
         Required. Specify up to 10 language codes here.
        repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTargetLanguageCodesList in interface BatchTranslateTextRequestOrBuilder
        Returns:
        A list containing the targetLanguageCodes.

      • getTargetLanguageCodesCount

        public int getTargetLanguageCodesCount()
         Required. Specify up to 10 language codes here.
        repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTargetLanguageCodesCount in interface BatchTranslateTextRequestOrBuilder
        Returns:
        The count of targetLanguageCodes.

      • getTargetLanguageCodes

        public String getTargetLanguageCodes​(int index)
         Required. Specify up to 10 language codes here.
        repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTargetLanguageCodes in interface BatchTranslateTextRequestOrBuilder
        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. Specify up to 10 language codes here.
        repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTargetLanguageCodesBytes in interface BatchTranslateTextRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the targetLanguageCodes at the given index.

      • getModelsCount

        public int getModelsCount()
        Description copied from interface: BatchTranslateTextRequestOrBuilder
         Optional. The models to use for translation. Map's key is target language
 code. Map's value is 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getModelsCount in interface BatchTranslateTextRequestOrBuilder

      • containsModels

        public boolean containsModels​(String key)
         Optional. The models to use for translation. Map's key is target language
 code. Map's value is 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsModels in interface BatchTranslateTextRequestOrBuilder

      • getModelsMap

        public Map<String,​String> getModelsMap()
         Optional. The models to use for translation. Map's key is target language
 code. Map's value is 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getModelsMap in interface BatchTranslateTextRequestOrBuilder

      • 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 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getModelsOrDefault in interface BatchTranslateTextRequestOrBuilder

      • getModelsOrThrow

        public String getModelsOrThrow​(String key)
         Optional. The models to use for translation. Map's key is target language
 code. Map's value is 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getModelsOrThrow in interface BatchTranslateTextRequestOrBuilder

      • getInputConfigsList

        public List<InputConfig> getInputConfigsList()
         Required. Input configurations.
 The total number of files matched should be <= 100.
 The total content size should be <= 100M Unicode codepoints.
 The files must use UTF-8 encoding.
        repeated .google.cloud.translation.v3.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputConfigsList in interface BatchTranslateTextRequestOrBuilder

      • getInputConfigsOrBuilderList

        public List<? extends InputConfigOrBuilder> getInputConfigsOrBuilderList()
         Required. Input configurations.
 The total number of files matched should be <= 100.
 The total content size should be <= 100M Unicode codepoints.
 The files must use UTF-8 encoding.
        repeated .google.cloud.translation.v3.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputConfigsOrBuilderList in interface BatchTranslateTextRequestOrBuilder

      • getInputConfigsCount

        public int getInputConfigsCount()
         Required. Input configurations.
 The total number of files matched should be <= 100.
 The total content size should be <= 100M Unicode codepoints.
 The files must use UTF-8 encoding.
        repeated .google.cloud.translation.v3.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputConfigsCount in interface BatchTranslateTextRequestOrBuilder

      • getInputConfigs

        public InputConfig getInputConfigs​(int index)
         Required. Input configurations.
 The total number of files matched should be <= 100.
 The total content size should be <= 100M Unicode codepoints.
 The files must use UTF-8 encoding.
        repeated .google.cloud.translation.v3.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputConfigs in interface BatchTranslateTextRequestOrBuilder

      • getInputConfigsOrBuilder

        public InputConfigOrBuilder getInputConfigsOrBuilder​(int index)
         Required. Input configurations.
 The total number of files matched should be <= 100.
 The total content size should be <= 100M Unicode codepoints.
 The files must use UTF-8 encoding.
        repeated .google.cloud.translation.v3.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputConfigsOrBuilder in interface BatchTranslateTextRequestOrBuilder

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

      • getOutputConfig

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

      • getOutputConfigOrBuilder

        public OutputConfigOrBuilder getOutputConfigOrBuilder()
         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.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getOutputConfigOrBuilder in interface BatchTranslateTextRequestOrBuilder

      • containsGlossaries

        public boolean containsGlossaries​(String key)
         Optional. Glossaries to be applied for translation.
 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 BatchTranslateTextRequestOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: BatchTranslateTextRequestOrBuilder
         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 = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsCount in interface BatchTranslateTextRequestOrBuilder

      • 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 = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsLabels in interface BatchTranslateTextRequestOrBuilder

      • 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 = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsMap in interface BatchTranslateTextRequestOrBuilder

      • 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 = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrDefault in interface BatchTranslateTextRequestOrBuilder

      • 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 = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrThrow in interface BatchTranslateTextRequestOrBuilder

      • 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 BatchTranslateTextRequest parseFrom​(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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