com.google.cloud.translate.v3beta1.BatchTranslateTextRequestOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-translate-v3beta1 Show documentation
Show all versions of proto-google-cloud-translate-v3beta1 Show documentation
PROTO library for proto-google-cloud-translate-v3beta1
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/translate/v3beta1/translation_service.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.translate.v3beta1;
public interface BatchTranslateTextRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.translation.v3beta1.BatchTranslateTextRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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) = { ... }
*
*
* @return The parent.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for parent.
*/
com.google.protobuf.ByteString getParentBytes();
/**
*
*
*
* Required. Source language code.
*
*
* string source_language_code = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The sourceLanguageCode.
*/
java.lang.String getSourceLanguageCode();
/**
*
*
*
* Required. Source language code.
*
*
* string source_language_code = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for sourceLanguageCode.
*/
com.google.protobuf.ByteString getSourceLanguageCodeBytes();
/**
*
*
*
* Required. Specify up to 10 language codes here.
*
*
* repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return A list containing the targetLanguageCodes.
*/
java.util.List getTargetLanguageCodesList();
/**
*
*
*
* Required. Specify up to 10 language codes here.
*
*
* repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The count of targetLanguageCodes.
*/
int getTargetLanguageCodesCount();
/**
*
*
*
* Required. Specify up to 10 language codes here.
*
*
* repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
*
*
* @param index The index of the element to return.
* @return The targetLanguageCodes at the given index.
*/
java.lang.String getTargetLanguageCodes(int index);
/**
*
*
*
* Required. Specify up to 10 language codes here.
*
*
* repeated string target_language_codes = 3 [(.google.api.field_behavior) = REQUIRED];
*
*
* @param index The index of the value to return.
* @return The bytes of the targetLanguageCodes at the given index.
*/
com.google.protobuf.ByteString getTargetLanguageCodesBytes(int index);
/**
*
*
*
* 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];
*/
int getModelsCount();
/**
*
*
*
* 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];
*/
boolean containsModels(java.lang.String key);
/** Use {@link #getModelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getModels();
/**
*
*
*
* 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];
*/
java.util.Map 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];
*/
/* nullable */
java.lang.String getModelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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];
*/
java.lang.String getModelsOrThrow(java.lang.String key);
/**
*
*
*
* 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.v3beta1.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];
*
*/
java.util.List 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.v3beta1.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.translate.v3beta1.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.v3beta1.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];
*
*/
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.v3beta1.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];
*
*/
java.util.List
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.v3beta1.InputConfig input_configs = 5 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.translate.v3beta1.InputConfigOrBuilder getInputConfigsOrBuilder(int index);
/**
*
*
*
* 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.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the outputConfig field is set.
*/
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.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The outputConfig.
*/
com.google.cloud.translate.v3beta1.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.v3beta1.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.translate.v3beta1.OutputConfigOrBuilder getOutputConfigOrBuilder();
/**
*
*
*
* Optional. Glossaries to be applied for translation.
* It's keyed by target language code.
*
*
*
* map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*/
int getGlossariesCount();
/**
*
*
*
* Optional. Glossaries to be applied for translation.
* It's keyed by target language code.
*
*
*
* map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*/
boolean containsGlossaries(java.lang.String key);
/** Use {@link #getGlossariesMap()} instead. */
@java.lang.Deprecated
java.util.Map
getGlossaries();
/**
*
*
*
* Optional. Glossaries to be applied for translation.
* It's keyed by target language code.
*
*
*
* map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.Map
getGlossariesMap();
/**
*
*
*
* Optional. Glossaries to be applied for translation.
* It's keyed by target language code.
*
*
*
* map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*/
/* nullable */
com.google.cloud.translate.v3beta1.TranslateTextGlossaryConfig getGlossariesOrDefault(
java.lang.String key,
/* nullable */
com.google.cloud.translate.v3beta1.TranslateTextGlossaryConfig defaultValue);
/**
*
*
*
* Optional. Glossaries to be applied for translation.
* It's keyed by target language code.
*
*
*
* map<string, .google.cloud.translation.v3beta1.TranslateTextGlossaryConfig> glossaries = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.translate.v3beta1.TranslateTextGlossaryConfig getGlossariesOrThrow(
java.lang.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/labels for more information.
*
*
* map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
*/
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/labels for more information.
*
*
* map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* 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/labels for more information.
*
*
* map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
*/
java.util.Map 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/labels for more information.
*
*
* map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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/labels for more information.
*
*
* map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
}