public final class TranslateDocumentRequest extends com.google.protobuf.GeneratedMessageV3 implements TranslateDocumentRequestOrBuilder
A document translation request.Protobuf type
google.cloud.translation.v3.TranslateDocumentRequest| Modifier and Type | Class and Description |
|---|---|
static class |
TranslateDocumentRequest.Builder
A document translation request.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
DOCUMENT_INPUT_CONFIG_FIELD_NUMBER |
static int |
DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER |
static int |
GLOSSARY_CONFIG_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
MODEL_FIELD_NUMBER |
static int |
PARENT_FIELD_NUMBER |
static int |
SOURCE_LANGUAGE_CODE_FIELD_NUMBER |
static int |
TARGET_LANGUAGE_CODE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
Optional.
|
boolean |
equals(Object obj) |
static TranslateDocumentRequest |
getDefaultInstance() |
TranslateDocumentRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
DocumentInputConfig |
getDocumentInputConfig()
Required.
|
DocumentInputConfigOrBuilder |
getDocumentInputConfigOrBuilder()
Required.
|
DocumentOutputConfig |
getDocumentOutputConfig()
Optional.
|
DocumentOutputConfigOrBuilder |
getDocumentOutputConfigOrBuilder()
Optional.
|
TranslateTextGlossaryConfig |
getGlossaryConfig()
Optional.
|
TranslateTextGlossaryConfigOrBuilder |
getGlossaryConfigOrBuilder()
Optional.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
Optional.
|
Map<String,String> |
getLabelsMap()
Optional.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
Optional.
|
String |
getLabelsOrThrow(String key)
Optional.
|
String |
getModel()
Optional.
|
com.google.protobuf.ByteString |
getModelBytes()
Optional.
|
String |
getParent()
Required.
|
com.google.protobuf.ByteString |
getParentBytes()
Required.
|
com.google.protobuf.Parser<TranslateDocumentRequest> |
getParserForType() |
int |
getSerializedSize() |
String |
getSourceLanguageCode()
Optional.
|
com.google.protobuf.ByteString |
getSourceLanguageCodeBytes()
Optional.
|
String |
getTargetLanguageCode()
Required.
|
com.google.protobuf.ByteString |
getTargetLanguageCodeBytes()
Required.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasDocumentInputConfig()
Required.
|
boolean |
hasDocumentOutputConfig()
Optional.
|
boolean |
hasGlossaryConfig()
Optional.
|
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static TranslateDocumentRequest.Builder |
newBuilder() |
static TranslateDocumentRequest.Builder |
newBuilder(TranslateDocumentRequest prototype) |
TranslateDocumentRequest.Builder |
newBuilderForType() |
protected TranslateDocumentRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static TranslateDocumentRequest |
parseDelimitedFrom(InputStream input) |
static TranslateDocumentRequest |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TranslateDocumentRequest |
parseFrom(byte[] data) |
static TranslateDocumentRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TranslateDocumentRequest |
parseFrom(ByteBuffer data) |
static TranslateDocumentRequest |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TranslateDocumentRequest |
parseFrom(com.google.protobuf.ByteString data) |
static TranslateDocumentRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TranslateDocumentRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static TranslateDocumentRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TranslateDocumentRequest |
parseFrom(InputStream input) |
static TranslateDocumentRequest |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<TranslateDocumentRequest> |
parser() |
TranslateDocumentRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int PARENT_FIELD_NUMBER
public static final int SOURCE_LANGUAGE_CODE_FIELD_NUMBER
public static final int TARGET_LANGUAGE_CODE_FIELD_NUMBER
public static final int DOCUMENT_INPUT_CONFIG_FIELD_NUMBER
public static final int DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER
public static final int MODEL_FIELD_NUMBER
public static final int GLOSSARY_CONFIG_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getParent()
Required. Location to make a regional call.
Format: `projects/{project-number-or-id}/locations/{location-id}`.
For global calls, use `projects/{project-number-or-id}/locations/global` or
`projects/{project-number-or-id}`.
Non-global location is required for requests using AutoML models or custom
glossaries.
Models and glossaries must be within the same region (have the same
location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
string parent = 1 [(.google.api.field_behavior) = REQUIRED];getParent in interface TranslateDocumentRequestOrBuilderpublic com.google.protobuf.ByteString getParentBytes()
Required. Location to make a regional call.
Format: `projects/{project-number-or-id}/locations/{location-id}`.
For global calls, use `projects/{project-number-or-id}/locations/global` or
`projects/{project-number-or-id}`.
Non-global location is required for requests using AutoML models or custom
glossaries.
Models and glossaries must be within the same region (have the same
location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
string parent = 1 [(.google.api.field_behavior) = REQUIRED];getParentBytes in interface TranslateDocumentRequestOrBuilderpublic 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];getSourceLanguageCode in interface TranslateDocumentRequestOrBuilderpublic 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];getSourceLanguageCodeBytes in interface TranslateDocumentRequestOrBuilderpublic 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];getTargetLanguageCode in interface TranslateDocumentRequestOrBuilderpublic 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];getTargetLanguageCodeBytes in interface TranslateDocumentRequestOrBuilderpublic boolean hasDocumentInputConfig()
Required. Input configurations.
.google.cloud.translation.v3.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
hasDocumentInputConfig in interface TranslateDocumentRequestOrBuilderpublic DocumentInputConfig getDocumentInputConfig()
Required. Input configurations.
.google.cloud.translation.v3.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
getDocumentInputConfig in interface TranslateDocumentRequestOrBuilderpublic DocumentInputConfigOrBuilder getDocumentInputConfigOrBuilder()
Required. Input configurations.
.google.cloud.translation.v3.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
getDocumentInputConfigOrBuilder in interface TranslateDocumentRequestOrBuilderpublic boolean hasDocumentOutputConfig()
Optional. Output configurations. Defines if the output file should be stored within Cloud Storage as well as the desired output format. If not provided the translated file will only be returned through a byte-stream and its output mime type will be the same as the input file's mime type.
.google.cloud.translation.v3.DocumentOutputConfig document_output_config = 5 [(.google.api.field_behavior) = OPTIONAL];
hasDocumentOutputConfig in interface TranslateDocumentRequestOrBuilderpublic DocumentOutputConfig getDocumentOutputConfig()
Optional. Output configurations. Defines if the output file should be stored within Cloud Storage as well as the desired output format. If not provided the translated file will only be returned through a byte-stream and its output mime type will be the same as the input file's mime type.
.google.cloud.translation.v3.DocumentOutputConfig document_output_config = 5 [(.google.api.field_behavior) = OPTIONAL];
getDocumentOutputConfig in interface TranslateDocumentRequestOrBuilderpublic DocumentOutputConfigOrBuilder getDocumentOutputConfigOrBuilder()
Optional. Output configurations. Defines if the output file should be stored within Cloud Storage as well as the desired output format. If not provided the translated file will only be returned through a byte-stream and its output mime type will be the same as the input file's mime type.
.google.cloud.translation.v3.DocumentOutputConfig document_output_config = 5 [(.google.api.field_behavior) = OPTIONAL];
getDocumentOutputConfigOrBuilder in interface TranslateDocumentRequestOrBuilderpublic 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];getModel in interface TranslateDocumentRequestOrBuilderpublic 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];getModelBytes in interface TranslateDocumentRequestOrBuilderpublic boolean hasGlossaryConfig()
Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.
.google.cloud.translation.v3.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];
hasGlossaryConfig in interface TranslateDocumentRequestOrBuilderpublic TranslateTextGlossaryConfig getGlossaryConfig()
Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.
.google.cloud.translation.v3.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];
getGlossaryConfig in interface TranslateDocumentRequestOrBuilderpublic TranslateTextGlossaryConfigOrBuilder getGlossaryConfigOrBuilder()
Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.
.google.cloud.translation.v3.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];
getGlossaryConfigOrBuilder in interface TranslateDocumentRequestOrBuilderpublic int getLabelsCount()
TranslateDocumentRequestOrBuilderOptional. 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];getLabelsCount in interface TranslateDocumentRequestOrBuilderpublic 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];containsLabels in interface TranslateDocumentRequestOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface TranslateDocumentRequestOrBuilderpublic 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];getLabelsMap in interface TranslateDocumentRequestOrBuilderpublic 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];getLabelsOrDefault in interface TranslateDocumentRequestOrBuilderpublic 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];getLabelsOrThrow in interface TranslateDocumentRequestOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static TranslateDocumentRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TranslateDocumentRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TranslateDocumentRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TranslateDocumentRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TranslateDocumentRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TranslateDocumentRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TranslateDocumentRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static TranslateDocumentRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static TranslateDocumentRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static TranslateDocumentRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static TranslateDocumentRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static TranslateDocumentRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic TranslateDocumentRequest.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static TranslateDocumentRequest.Builder newBuilder()
public static TranslateDocumentRequest.Builder newBuilder(TranslateDocumentRequest prototype)
public TranslateDocumentRequest.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected TranslateDocumentRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static TranslateDocumentRequest getDefaultInstance()
public static com.google.protobuf.Parser<TranslateDocumentRequest> parser()
public com.google.protobuf.Parser<TranslateDocumentRequest> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public TranslateDocumentRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.