- 2.53.0 (latest)
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.5
- 2.2.0
- 2.1.13
public static final class TranslateDocumentRequest.Builder extends GeneratedMessageV3.Builder<TranslateDocumentRequest.Builder> implements TranslateDocumentRequestOrBuilderA document translation request.
Protobuf type google.cloud.translation.v3beta1.TranslateDocumentRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TranslateDocumentRequest.BuilderImplements
TranslateDocumentRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TranslateDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
build()
public TranslateDocumentRequest build()| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest | |
buildPartial()
public TranslateDocumentRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest | |
clear()
public TranslateDocumentRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
clearCustomizedAttribution()
public TranslateDocumentRequest.Builder clearCustomizedAttribution() 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 |
TranslateDocumentRequest.Builder | This builder for chaining. |
clearDocumentInputConfig()
public TranslateDocumentRequest.Builder clearDocumentInputConfig()Required. Input configurations.
.google.cloud.translation.v3beta1.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
clearDocumentOutputConfig()
public TranslateDocumentRequest.Builder clearDocumentOutputConfig()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 |
TranslateDocumentRequest.Builder | |
clearEnableRotationCorrection()
public TranslateDocumentRequest.Builder clearEnableRotationCorrection()Optional. If true, enable auto rotation correction in DVS.
bool enable_rotation_correction = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | This builder for chaining. |
clearEnableShadowRemovalNativePdf()
public TranslateDocumentRequest.Builder clearEnableShadowRemovalNativePdf()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 |
TranslateDocumentRequest.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public TranslateDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
clearGlossaryConfig()
public TranslateDocumentRequest.Builder clearGlossaryConfig()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 |
TranslateDocumentRequest.Builder | |
clearIsTranslateNativePdfOnly()
public TranslateDocumentRequest.Builder clearIsTranslateNativePdfOnly()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 |
TranslateDocumentRequest.Builder | This builder for chaining. |
clearLabels()
public TranslateDocumentRequest.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
clearModel()
public TranslateDocumentRequest.Builder clearModel() 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 |
TranslateDocumentRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public TranslateDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
clearParent()
public TranslateDocumentRequest.Builder clearParent()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 |
TranslateDocumentRequest.Builder | This builder for chaining. |
clearSourceLanguageCode()
public TranslateDocumentRequest.Builder clearSourceLanguageCode()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 |
TranslateDocumentRequest.Builder | This builder for chaining. |
clearTargetLanguageCode()
public TranslateDocumentRequest.Builder clearTargetLanguageCode()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 |
TranslateDocumentRequest.Builder | This builder for chaining. |
clone()
public TranslateDocumentRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
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 |
| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString | The bytes for customizedAttribution. |
getDefaultInstanceForType()
public TranslateDocumentRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getDocumentInputConfig()
public 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. |
getDocumentInputConfigBuilder()
public DocumentInputConfig.Builder getDocumentInputConfigBuilder()Required. Input configurations.
.google.cloud.translation.v3beta1.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
DocumentInputConfig.Builder | |
getDocumentInputConfigOrBuilder()
public 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 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. |
getDocumentOutputConfigBuilder()
public DocumentOutputConfig.Builder getDocumentOutputConfigBuilder()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.Builder | |
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];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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];
| Returns | |
|---|---|
| Type | Description |
TranslateTextGlossaryConfig | The glossaryConfig. |
getGlossaryConfigBuilder()
public TranslateTextGlossaryConfig.Builder getGlossaryConfigBuilder()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.Builder | |
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];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean | The isTranslateNativePdfOnly. |
getLabels()
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| 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()
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 | |
|---|---|
| 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. |
getMutableLabels()
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
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. |
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. |
hasDocumentInputConfig()
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeDocumentInputConfig(DocumentInputConfig value)
public TranslateDocumentRequest.Builder mergeDocumentInputConfig(DocumentInputConfig value)Required. Input configurations.
.google.cloud.translation.v3beta1.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | DocumentInputConfig |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
mergeDocumentOutputConfig(DocumentOutputConfig value)
public TranslateDocumentRequest.Builder mergeDocumentOutputConfig(DocumentOutputConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value | DocumentOutputConfig |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
mergeFrom(TranslateDocumentRequest other)
public TranslateDocumentRequest.Builder mergeFrom(TranslateDocumentRequest other)| Parameter | |
|---|---|
| Name | Description |
other | TranslateDocumentRequest |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TranslateDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public TranslateDocumentRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
mergeGlossaryConfig(TranslateTextGlossaryConfig value)
public TranslateDocumentRequest.Builder mergeGlossaryConfig(TranslateTextGlossaryConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value | TranslateTextGlossaryConfig |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TranslateDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
putAllLabels(Map<String,String> values)
public TranslateDocumentRequest.Builder putAllLabels(Map<String,String> values)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 |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
putLabels(String key, String value)
public TranslateDocumentRequest.Builder putLabels(String key, String value)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 | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
removeLabels(String key)
public TranslateDocumentRequest.Builder removeLabels(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 |
TranslateDocumentRequest.Builder | |
setCustomizedAttribution(String value)
public TranslateDocumentRequest.Builder setCustomizedAttribution(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe customizedAttribution to set. |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | This builder for chaining. |
setCustomizedAttributionBytes(ByteString value)
public TranslateDocumentRequest.Builder setCustomizedAttributionBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for customizedAttribution to set. |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | This builder for chaining. |
setDocumentInputConfig(DocumentInputConfig value)
public TranslateDocumentRequest.Builder setDocumentInputConfig(DocumentInputConfig value)Required. Input configurations.
.google.cloud.translation.v3beta1.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | DocumentInputConfig |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
setDocumentInputConfig(DocumentInputConfig.Builder builderForValue)
public TranslateDocumentRequest.Builder setDocumentInputConfig(DocumentInputConfig.Builder builderForValue)Required. Input configurations.
.google.cloud.translation.v3beta1.DocumentInputConfig document_input_config = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | DocumentInputConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
setDocumentOutputConfig(DocumentOutputConfig value)
public TranslateDocumentRequest.Builder setDocumentOutputConfig(DocumentOutputConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value | DocumentOutputConfig |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
setDocumentOutputConfig(DocumentOutputConfig.Builder builderForValue)
public TranslateDocumentRequest.Builder setDocumentOutputConfig(DocumentOutputConfig.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | DocumentOutputConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
setEnableRotationCorrection(boolean value)
public TranslateDocumentRequest.Builder setEnableRotationCorrection(boolean value)Optional. If true, enable auto rotation correction in DVS.
bool enable_rotation_correction = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe enableRotationCorrection to set. |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | This builder for chaining. |
setEnableShadowRemovalNativePdf(boolean value)
public TranslateDocumentRequest.Builder setEnableShadowRemovalNativePdf(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe enableShadowRemovalNativePdf to set. |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public TranslateDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
setGlossaryConfig(TranslateTextGlossaryConfig value)
public TranslateDocumentRequest.Builder setGlossaryConfig(TranslateTextGlossaryConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value | TranslateTextGlossaryConfig |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
setGlossaryConfig(TranslateTextGlossaryConfig.Builder builderForValue)
public TranslateDocumentRequest.Builder setGlossaryConfig(TranslateTextGlossaryConfig.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | TranslateTextGlossaryConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
setIsTranslateNativePdfOnly(boolean value)
public TranslateDocumentRequest.Builder setIsTranslateNativePdfOnly(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe isTranslateNativePdfOnly to set. |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | This builder for chaining. |
setModel(String value)
public TranslateDocumentRequest.Builder setModel(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe model to set. |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | This builder for chaining. |
setModelBytes(ByteString value)
public TranslateDocumentRequest.Builder setModelBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for model to set. |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | This builder for chaining. |
setParent(String value)
public TranslateDocumentRequest.Builder setParent(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public TranslateDocumentRequest.Builder setParentBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TranslateDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |
setSourceLanguageCode(String value)
public TranslateDocumentRequest.Builder setSourceLanguageCode(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe sourceLanguageCode to set. |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | This builder for chaining. |
setSourceLanguageCodeBytes(ByteString value)
public TranslateDocumentRequest.Builder setSourceLanguageCodeBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for sourceLanguageCode to set. |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | This builder for chaining. |
setTargetLanguageCode(String value)
public TranslateDocumentRequest.Builder setTargetLanguageCode(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe targetLanguageCode to set. |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | This builder for chaining. |
setTargetLanguageCodeBytes(ByteString value)
public TranslateDocumentRequest.Builder setTargetLanguageCodeBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for targetLanguageCode to set. |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final TranslateDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TranslateDocumentRequest.Builder | |