public final class TranslateDocumentRequest extends GeneratedMessageV3 implements TranslateDocumentRequestOrBuilder
A document translation request.
Protobuf type google.cloud.translation.v3.TranslateDocumentRequest
Static Fields
CUSTOMIZED_ATTRIBUTION_FIELD_NUMBER
public static final int CUSTOMIZED_ATTRIBUTION_FIELD_NUMBER
Field Value
public static final int DOCUMENT_INPUT_CONFIG_FIELD_NUMBER
Field Value
DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER
public static final int DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER
Field Value
ENABLE_SHADOW_REMOVAL_NATIVE_PDF_FIELD_NUMBER
public static final int ENABLE_SHADOW_REMOVAL_NATIVE_PDF_FIELD_NUMBER
Field Value
GLOSSARY_CONFIG_FIELD_NUMBER
public static final int GLOSSARY_CONFIG_FIELD_NUMBER
Field Value
IS_TRANSLATE_NATIVE_PDF_ONLY_FIELD_NUMBER
public static final int IS_TRANSLATE_NATIVE_PDF_ONLY_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
MODEL_FIELD_NUMBER
public static final int MODEL_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
SOURCE_LANGUAGE_CODE_FIELD_NUMBER
public static final int SOURCE_LANGUAGE_CODE_FIELD_NUMBER
Field Value
TARGET_LANGUAGE_CODE_FIELD_NUMBER
public static final int TARGET_LANGUAGE_CODE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static TranslateDocumentRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static TranslateDocumentRequest.Builder newBuilder()
Returns
newBuilder(TranslateDocumentRequest prototype)
public static TranslateDocumentRequest.Builder newBuilder(TranslateDocumentRequest prototype)
Parameter
Returns
public static TranslateDocumentRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static TranslateDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TranslateDocumentRequest parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TranslateDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TranslateDocumentRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TranslateDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TranslateDocumentRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static TranslateDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TranslateDocumentRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static TranslateDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TranslateDocumentRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TranslateDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<TranslateDocumentRequest> parser()
Returns
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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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()
Returns
public DocumentInputConfig getDocumentInputConfig()
Required. Input configurations.
.google.cloud.translation.v3.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
public DocumentInputConfigOrBuilder getDocumentInputConfigOrBuilder()
Required. Input configurations.
.google.cloud.translation.v3.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.v3.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.v3.DocumentOutputConfig document_output_config = 5 [(.google.api.field_behavior) = OPTIONAL];
getEnableShadowRemovalNativePdf()
public boolean getEnableShadowRemovalNativePdf()
Optional. If true, use the text removal 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 is false
bool enable_shadow_removal_native_pdf = 12 [(.google.api.field_behavior) = OPTIONAL];
| 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.v3.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.v3.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];
getIsTranslateNativePdfOnly()
public boolean getIsTranslateNativePdfOnly()
Optional. 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];
| Type | Description |
boolean | The isTranslateNativePdfOnly.
|
getLabels()
public Map<String,String> getLabels()
Returns
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];
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];
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];
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];
| 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];
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 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];
| 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 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];
getParserForType()
public Parser<TranslateDocumentRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSourceLanguageCode()
public String getSourceLanguageCode()
Optional. The ISO-639 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];
| Type | Description |
String | The sourceLanguageCode.
|
getSourceLanguageCodeBytes()
public ByteString getSourceLanguageCodeBytes()
Optional. The ISO-639 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];
| Type | Description |
ByteString | The bytes for sourceLanguageCode.
|
getTargetLanguageCode()
public String getTargetLanguageCode()
Required. The ISO-639 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];
| Type | Description |
String | The targetLanguageCode.
|
getTargetLanguageCodeBytes()
public ByteString getTargetLanguageCodeBytes()
Required. The ISO-639 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];
| Type | Description |
ByteString | The bytes for targetLanguageCode.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public boolean hasDocumentInputConfig()
Required. Input configurations.
.google.cloud.translation.v3.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
| 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.v3.DocumentOutputConfig document_output_config = 5 [(.google.api.field_behavior) = OPTIONAL];
| 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.v3.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
boolean | Whether the glossaryConfig field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public TranslateDocumentRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TranslateDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public TranslateDocumentRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
