public final class TranslateDocumentRequest extends GeneratedMessageV3 implements TranslateDocumentRequestOrBuilder
A document translation request.
Protobuf type google.cloud.translation.v3beta1.TranslateDocumentRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CUSTOMIZED_ATTRIBUTION_FIELD_NUMBER
public static final int CUSTOMIZED_ATTRIBUTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DOCUMENT_INPUT_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER
public static final int DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENABLE_ROTATION_CORRECTION_FIELD_NUMBER
public static final int ENABLE_ROTATION_CORRECTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENABLE_SHADOW_REMOVAL_NATIVE_PDF_FIELD_NUMBER
public static final int ENABLE_SHADOW_REMOVAL_NATIVE_PDF_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GLOSSARY_CONFIG_FIELD_NUMBER
public static final int GLOSSARY_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
IS_TRANSLATE_NATIVE_PDF_ONLY_FIELD_NUMBER
public static final int IS_TRANSLATE_NATIVE_PDF_ONLY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MODEL_FIELD_NUMBER
public static final int MODEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SOURCE_LANGUAGE_CODE_FIELD_NUMBER
public static final int SOURCE_LANGUAGE_CODE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TARGET_LANGUAGE_CODE_FIELD_NUMBER
public static final int TARGET_LANGUAGE_CODE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static TranslateDocumentRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static TranslateDocumentRequest.Builder newBuilder()
newBuilder(TranslateDocumentRequest prototype)
public static TranslateDocumentRequest.Builder newBuilder(TranslateDocumentRequest prototype)
public static TranslateDocumentRequest parseDelimitedFrom(InputStream input)
public static TranslateDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static TranslateDocumentRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TranslateDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static TranslateDocumentRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TranslateDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TranslateDocumentRequest parseFrom(CodedInputStream input)
public static TranslateDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TranslateDocumentRequest parseFrom(InputStream input)
public static TranslateDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static TranslateDocumentRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TranslateDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<TranslateDocumentRequest> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Optional. The labels with user-defined metadata for the request.
Label keys and values can be no longer than 63 characters (Unicode
codepoints), can only contain lowercase letters, numeric characters,
underscores and dashes. International characters are allowed. Label values
are optional. Label keys must start with a letter.
See https://cloud.google.com/translate/docs/advanced/labels for more
information.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCustomizedAttribution()
public String getCustomizedAttribution()
| Returns |
| Type |
Description |
String |
The customizedAttribution.
|
getCustomizedAttributionBytes()
public ByteString getCustomizedAttributionBytes()
| Returns |
| Type |
Description |
ByteString |
The bytes for customizedAttribution.
|
getDefaultInstanceForType()
public TranslateDocumentRequest getDefaultInstanceForType()
public DocumentInputConfig getDocumentInputConfig()
Required. Input configurations.
.google.cloud.translation.v3beta1.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
public DocumentInputConfigOrBuilder getDocumentInputConfigOrBuilder()
Required. Input configurations.
.google.cloud.translation.v3beta1.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
getDocumentOutputConfig()
public DocumentOutputConfig getDocumentOutputConfig()
Optional. Output configurations.
Defines if the output file should be stored within Cloud Storage as well
as the desired output format. If not provided the translated file will
only be returned through a byte-stream and its output mime type will be
the same as the input file's mime type.
.google.cloud.translation.v3beta1.DocumentOutputConfig document_output_config = 5 [(.google.api.field_behavior) = OPTIONAL];
getDocumentOutputConfigOrBuilder()
public DocumentOutputConfigOrBuilder getDocumentOutputConfigOrBuilder()
Optional. Output configurations.
Defines if the output file should be stored within Cloud Storage as well
as the desired output format. If not provided the translated file will
only be returned through a byte-stream and its output mime type will be
the same as the input file's mime type.
.google.cloud.translation.v3beta1.DocumentOutputConfig document_output_config = 5 [(.google.api.field_behavior) = OPTIONAL];
getEnableRotationCorrection()
public boolean getEnableRotationCorrection()
Optional. If true, enable auto rotation correction in DVS.
bool enable_rotation_correction = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The enableRotationCorrection.
|
getEnableShadowRemovalNativePdf()
public boolean getEnableShadowRemovalNativePdf()
Optional. If true, use the text removal server to remove the shadow text on
background image for native pdf translation.
Shadow removal feature can only be enabled when
is_translate_native_pdf_only: false && pdf_native_only: false
bool enable_shadow_removal_native_pdf = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The enableShadowRemovalNativePdf.
|
getGlossaryConfig()
public TranslateTextGlossaryConfig getGlossaryConfig()
Optional. Glossary to be applied. The glossary must be within the same
region (have the same location-id) as the model, otherwise an
INVALID_ARGUMENT (400) error is returned.
.google.cloud.translation.v3beta1.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];
getGlossaryConfigOrBuilder()
public TranslateTextGlossaryConfigOrBuilder getGlossaryConfigOrBuilder()
Optional. Glossary to be applied. The glossary must be within the same
region (have the same location-id) as the model, otherwise an
INVALID_ARGUMENT (400) error is returned.
.google.cloud.translation.v3beta1.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];
getIsTranslateNativePdfOnly()
public boolean getIsTranslateNativePdfOnly()
Optional. is_translate_native_pdf_only field for external customers.
If true, the page limit of online native pdf translation is 300 and only
native pdf pages will be translated.
bool is_translate_native_pdf_only = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The isTranslateNativePdfOnly.
|
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public 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/advanced/labels for more
information.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. The labels with user-defined metadata for the request.
Label keys and values can be no longer than 63 characters (Unicode
codepoints), can only contain lowercase letters, numeric characters,
underscores and dashes. International characters are allowed. Label values
are optional. Label keys must start with a letter.
See https://cloud.google.com/translate/docs/advanced/labels for more
information.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. The labels with user-defined metadata for the request.
Label keys and values can be no longer than 63 characters (Unicode
codepoints), can only contain lowercase letters, numeric characters,
underscores and dashes. International characters are allowed. Label values
are optional. Label keys must start with a letter.
See https://cloud.google.com/translate/docs/advanced/labels for more
information.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional. The labels with user-defined metadata for the request.
Label keys and values can be no longer than 63 characters (Unicode
codepoints), can only contain lowercase letters, numeric characters,
underscores and dashes. International characters are allowed. Label values
are optional. Label keys must start with a letter.
See https://cloud.google.com/translate/docs/advanced/labels for more
information.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
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];
| Returns |
| Type |
Description |
String |
The model.
|
getModelBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for model.
|
getParent()
public String getParent()
Required. Location to make a regional call.
Format: projects/{project-number-or-id}/locations/{location-id}.
For global calls, use projects/{project-number-or-id}/locations/global.
Non-global location is required for requests using AutoML models or custom
glossaries.
Models and glossaries must be within the same region (have the same
location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
string parent = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The parent.
|
getParentBytes()
public ByteString getParentBytes()
Required. Location to make a regional call.
Format: projects/{project-number-or-id}/locations/{location-id}.
For global calls, use projects/{project-number-or-id}/locations/global.
Non-global location is required for requests using AutoML models or custom
glossaries.
Models and glossaries must be within the same region (have the same
location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
string parent = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
getParserForType()
public Parser<TranslateDocumentRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSourceLanguageCode()
public String getSourceLanguageCode()
Optional. The BCP-47 language code of the input document if known, for
example, "en-US" or "sr-Latn". Supported language codes are listed in
Language Support. If the source language isn't specified, the API attempts
to identify the source language automatically and returns the source
language within the response. Source language must be specified if the
request contains a glossary or a custom model.
string source_language_code = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The sourceLanguageCode.
|
getSourceLanguageCodeBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for sourceLanguageCode.
|
getTargetLanguageCode()
public String getTargetLanguageCode()
Required. The BCP-47 language code to use for translation of the input
document, set to one of the language codes listed in Language Support.
string target_language_code = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The targetLanguageCode.
|
getTargetLanguageCodeBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for targetLanguageCode.
|
public boolean hasDocumentInputConfig()
Required. Input configurations.
.google.cloud.translation.v3beta1.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the documentInputConfig field is set.
|
hasDocumentOutputConfig()
public boolean hasDocumentOutputConfig()
Optional. Output configurations.
Defines if the output file should be stored within Cloud Storage as well
as the desired output format. If not provided the translated file will
only be returned through a byte-stream and its output mime type will be
the same as the input file's mime type.
.google.cloud.translation.v3beta1.DocumentOutputConfig document_output_config = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the documentOutputConfig field is set.
|
hasGlossaryConfig()
public boolean hasGlossaryConfig()
Optional. Glossary to be applied. The glossary must be within the same
region (have the same location-id) as the model, otherwise an
INVALID_ARGUMENT (400) error is returned.
.google.cloud.translation.v3beta1.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the glossaryConfig field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public TranslateDocumentRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TranslateDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public TranslateDocumentRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
