Class TranslateDocumentRequest (2.34.0)

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
TypeDescription
int

DOCUMENT_INPUT_CONFIG_FIELD_NUMBER

public static final int DOCUMENT_INPUT_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER

public static final int DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLE_ROTATION_CORRECTION_FIELD_NUMBER

public static final int ENABLE_ROTATION_CORRECTION_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLE_SHADOW_REMOVAL_NATIVE_PDF_FIELD_NUMBER

public static final int ENABLE_SHADOW_REMOVAL_NATIVE_PDF_FIELD_NUMBER
Field Value
TypeDescription
int

GLOSSARY_CONFIG_FIELD_NUMBER

public static final int GLOSSARY_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

IS_TRANSLATE_NATIVE_PDF_ONLY_FIELD_NUMBER

public static final int IS_TRANSLATE_NATIVE_PDF_ONLY_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_LANGUAGE_CODE_FIELD_NUMBER

public static final int SOURCE_LANGUAGE_CODE_FIELD_NUMBER
Field Value
TypeDescription
int

TARGET_LANGUAGE_CODE_FIELD_NUMBER

public static final int TARGET_LANGUAGE_CODE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TranslateDocumentRequest getDefaultInstance()
Returns
TypeDescription
TranslateDocumentRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static TranslateDocumentRequest.Builder newBuilder()
Returns
TypeDescription
TranslateDocumentRequest.Builder

newBuilder(TranslateDocumentRequest prototype)

public static TranslateDocumentRequest.Builder newBuilder(TranslateDocumentRequest prototype)
Parameter
NameDescription
prototypeTranslateDocumentRequest
Returns
TypeDescription
TranslateDocumentRequest.Builder

parseDelimitedFrom(InputStream input)

public static TranslateDocumentRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TranslateDocumentRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TranslateDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TranslateDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TranslateDocumentRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TranslateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TranslateDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TranslateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TranslateDocumentRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TranslateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TranslateDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TranslateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TranslateDocumentRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TranslateDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TranslateDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TranslateDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TranslateDocumentRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TranslateDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TranslateDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TranslateDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TranslateDocumentRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TranslateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TranslateDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TranslateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TranslateDocumentRequest> parser()
Returns
TypeDescription
Parser<TranslateDocumentRequest>

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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCustomizedAttribution()

public String getCustomizedAttribution()

Optional. This flag is to support user customized attribution. If not provided, the default is Machine Translated by Google. Customized attribution should follow rules in https://cloud.google.com/translate/attribution#attribution_and_logos

string customized_attribution = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The customizedAttribution.

getCustomizedAttributionBytes()

public ByteString getCustomizedAttributionBytes()

Optional. This flag is to support user customized attribution. If not provided, the default is Machine Translated by Google. Customized attribution should follow rules in https://cloud.google.com/translate/attribution#attribution_and_logos

string customized_attribution = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for customizedAttribution.

getDefaultInstanceForType()

public TranslateDocumentRequest getDefaultInstanceForType()
Returns
TypeDescription
TranslateDocumentRequest

getDocumentInputConfig()

public DocumentInputConfig getDocumentInputConfig()

Required. Input configurations.

.google.cloud.translation.v3.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
DocumentInputConfig

The documentInputConfig.

getDocumentInputConfigOrBuilder()

public DocumentInputConfigOrBuilder getDocumentInputConfigOrBuilder()

Required. Input configurations.

.google.cloud.translation.v3.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
DocumentInputConfigOrBuilder

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];

Returns
TypeDescription
DocumentOutputConfig

The documentOutputConfig.

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];

Returns
TypeDescription
DocumentOutputConfigOrBuilder

getEnableRotationCorrection()

public boolean getEnableRotationCorrection()

Optional. If true, enable auto rotation correction in DVS.

bool enable_rotation_correction = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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
TypeDescription
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];

Returns
TypeDescription
TranslateTextGlossaryConfig

The glossaryConfig.

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];

Returns
TypeDescription
TranslateTextGlossaryConfigOrBuilder

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
TypeDescription
boolean

The isTranslateNativePdfOnly.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

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
TypeDescription
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];

Returns
TypeDescription
Map<String,String>

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];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getModel()

public 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
TypeDescription
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
TypeDescription
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 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];

Returns
TypeDescription
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];

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<TranslateDocumentRequest> getParserForType()
Returns
TypeDescription
Parser<TranslateDocumentRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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];

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
ByteString

The bytes for targetLanguageCode.

hasDocumentInputConfig()

public boolean hasDocumentInputConfig()

Required. Input configurations.

.google.cloud.translation.v3.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
boolean

Whether the glossaryConfig field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TranslateDocumentRequest.Builder newBuilderForType()
Returns
TypeDescription
TranslateDocumentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TranslateDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TranslateDocumentRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TranslateDocumentRequest.Builder toBuilder()
Returns
TypeDescription
TranslateDocumentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException