Interface TranslateDocumentRequestOrBuilder (2.39.0)

public interface TranslateDocumentRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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`

Returns
Type	Description
`boolean`

getCustomizedAttribution()

public abstract 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
Type	Description
`String`	The customizedAttribution.

getCustomizedAttributionBytes()

public abstract ByteString getCustomizedAttributionBytes()

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

Returns
Type	Description
`ByteString`	The bytes for customizedAttribution.

getDocumentInputConfig()

public abstract DocumentInputConfig getDocumentInputConfig()

Required. Input configurations.

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

Returns
Type	Description
`DocumentInputConfig`	The documentInputConfig.

getDocumentInputConfigOrBuilder()

public abstract DocumentInputConfigOrBuilder getDocumentInputConfigOrBuilder()

Required. Input configurations.

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

Returns
Type	Description
`DocumentInputConfigOrBuilder`

getDocumentOutputConfig()

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

Returns
Type	Description
`DocumentOutputConfig`	The documentOutputConfig.

getDocumentOutputConfigOrBuilder()

public abstract DocumentOutputConfigOrBuilder getDocumentOutputConfigOrBuilder()

.google.cloud.translation.v3beta1.DocumentOutputConfig document_output_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`DocumentOutputConfigOrBuilder`

getEnableRotationCorrection()

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

Returns
Type	Description
`TranslateTextGlossaryConfig`	The glossaryConfig.

getGlossaryConfigOrBuilder()

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

Returns
Type	Description
`TranslateTextGlossaryConfigOrBuilder`

getIsTranslateNativePdfOnly()

public abstract 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 abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public abstract int getLabelsCount()

Optional. The labels with user-defined metadata for the request.

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 abstract Map<String,String> getLabelsMap()

Optional. The labels with user-defined metadata for the request.

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
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. The labels with user-defined metadata for the request.

See https://cloud.google.com/translate/docs/advanced/labels for more information.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. The labels with user-defined metadata for the request.

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()

public abstract 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 abstract 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 abstract 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 abstract 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.

getSourceLanguageCode()

public abstract 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 abstract ByteString getSourceLanguageCodeBytes()

string source_language_code = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for sourceLanguageCode.

getTargetLanguageCode()

public abstract 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 abstract 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.

hasDocumentInputConfig()

public abstract 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 abstract boolean hasDocumentOutputConfig()

.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 abstract 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.