- 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 DocumentOutputConfig.Builder extends GeneratedMessageV3.Builder<DocumentOutputConfig.Builder> implements DocumentOutputConfigOrBuilderA document translation request output config.
Protobuf type google.cloud.translation.v3.DocumentOutputConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DocumentOutputConfig.BuilderImplements
DocumentOutputConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DocumentOutputConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|
build()
public DocumentOutputConfig build()| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig |
|
buildPartial()
public DocumentOutputConfig buildPartial()| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig |
|
clear()
public DocumentOutputConfig.Builder clear()| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|
clearDestination()
public DocumentOutputConfig.Builder clearDestination()| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public DocumentOutputConfig.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|
clearGcsDestination()
public DocumentOutputConfig.Builder clearGcsDestination() Optional. Google Cloud Storage destination for the translation output,
e.g., gs://my_bucket/my_directory/.
The destination directory provided does not have to be empty, but the bucket must exist. If a file with the same name as the output file already exists in the destination an error will be returned.
For a DocumentInputConfig.contents provided document, the output file will have the name "output_[trg]_translations.[ext]", where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension according to its mime type.
For a DocumentInputConfig.gcs_uri provided document, the output file will
have a name according to its URI. For example: an input file with URI:
gs://a/b/c.[extension] stored in a gcs_destination bucket with name
"my_bucket" will have an output URI:
gs://my_bucket/a_b_c_[trg]_translations.[ext], where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension according to its mime type.
If the document was directly provided through the request, then the
output document will have the format:
gs://my_bucket/translated_document_[trg]_translations.[ext], where
- [trg] corresponds to the translated file's language code,
[ext] corresponds to the translated file's extension according to its mime type.
If a glossary was provided, then the output URI for the glossary translation will be equal to the default output URI but have
glossary_translationsinstead oftranslations. For the previous example, its glossary URI would be:gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext].Thus the max number of output files will be 2 (Translated document, Glossary translated document).
Callers should expect no partial outputs. If there is any error during document translation, no output will be stored in the Cloud Storage bucket.
.google.cloud.translation.v3.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|
clearMimeType()
public DocumentOutputConfig.Builder clearMimeType()Optional. Specifies the translated document's mime_type. If not specified, the translated file's mime type will be the same as the input file's mime type. Currently only support the output mime type to be the same as input mime type.
- application/pdf
- application/vnd.openxmlformats-officedocument.wordprocessingml.document
- application/vnd.openxmlformats-officedocument.presentationml.presentation
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public DocumentOutputConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|
clone()
public DocumentOutputConfig.Builder clone()| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|
getDefaultInstanceForType()
public DocumentOutputConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDestinationCase()
public DocumentOutputConfig.DestinationCase getDestinationCase()| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.DestinationCase |
|
getGcsDestination()
public GcsDestination getGcsDestination() Optional. Google Cloud Storage destination for the translation output,
e.g., gs://my_bucket/my_directory/.
The destination directory provided does not have to be empty, but the bucket must exist. If a file with the same name as the output file already exists in the destination an error will be returned.
For a DocumentInputConfig.contents provided document, the output file will have the name "output_[trg]_translations.[ext]", where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension according to its mime type.
For a DocumentInputConfig.gcs_uri provided document, the output file will
have a name according to its URI. For example: an input file with URI:
gs://a/b/c.[extension] stored in a gcs_destination bucket with name
"my_bucket" will have an output URI:
gs://my_bucket/a_b_c_[trg]_translations.[ext], where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension according to its mime type.
If the document was directly provided through the request, then the
output document will have the format:
gs://my_bucket/translated_document_[trg]_translations.[ext], where
- [trg] corresponds to the translated file's language code,
[ext] corresponds to the translated file's extension according to its mime type.
If a glossary was provided, then the output URI for the glossary translation will be equal to the default output URI but have
glossary_translationsinstead oftranslations. For the previous example, its glossary URI would be:gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext].Thus the max number of output files will be 2 (Translated document, Glossary translated document).
Callers should expect no partial outputs. If there is any error during document translation, no output will be stored in the Cloud Storage bucket.
.google.cloud.translation.v3.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GcsDestination |
The gcsDestination. |
getGcsDestinationBuilder()
public GcsDestination.Builder getGcsDestinationBuilder() Optional. Google Cloud Storage destination for the translation output,
e.g., gs://my_bucket/my_directory/.
The destination directory provided does not have to be empty, but the bucket must exist. If a file with the same name as the output file already exists in the destination an error will be returned.
For a DocumentInputConfig.contents provided document, the output file will have the name "output_[trg]_translations.[ext]", where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension according to its mime type.
For a DocumentInputConfig.gcs_uri provided document, the output file will
have a name according to its URI. For example: an input file with URI:
gs://a/b/c.[extension] stored in a gcs_destination bucket with name
"my_bucket" will have an output URI:
gs://my_bucket/a_b_c_[trg]_translations.[ext], where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension according to its mime type.
If the document was directly provided through the request, then the
output document will have the format:
gs://my_bucket/translated_document_[trg]_translations.[ext], where
- [trg] corresponds to the translated file's language code,
[ext] corresponds to the translated file's extension according to its mime type.
If a glossary was provided, then the output URI for the glossary translation will be equal to the default output URI but have
glossary_translationsinstead oftranslations. For the previous example, its glossary URI would be:gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext].Thus the max number of output files will be 2 (Translated document, Glossary translated document).
Callers should expect no partial outputs. If there is any error during document translation, no output will be stored in the Cloud Storage bucket.
.google.cloud.translation.v3.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GcsDestination.Builder |
|
getGcsDestinationOrBuilder()
public GcsDestinationOrBuilder getGcsDestinationOrBuilder() Optional. Google Cloud Storage destination for the translation output,
e.g., gs://my_bucket/my_directory/.
The destination directory provided does not have to be empty, but the bucket must exist. If a file with the same name as the output file already exists in the destination an error will be returned.
For a DocumentInputConfig.contents provided document, the output file will have the name "output_[trg]_translations.[ext]", where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension according to its mime type.
For a DocumentInputConfig.gcs_uri provided document, the output file will
have a name according to its URI. For example: an input file with URI:
gs://a/b/c.[extension] stored in a gcs_destination bucket with name
"my_bucket" will have an output URI:
gs://my_bucket/a_b_c_[trg]_translations.[ext], where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension according to its mime type.
If the document was directly provided through the request, then the
output document will have the format:
gs://my_bucket/translated_document_[trg]_translations.[ext], where
- [trg] corresponds to the translated file's language code,
[ext] corresponds to the translated file's extension according to its mime type.
If a glossary was provided, then the output URI for the glossary translation will be equal to the default output URI but have
glossary_translationsinstead oftranslations. For the previous example, its glossary URI would be:gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext].Thus the max number of output files will be 2 (Translated document, Glossary translated document).
Callers should expect no partial outputs. If there is any error during document translation, no output will be stored in the Cloud Storage bucket.
.google.cloud.translation.v3.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GcsDestinationOrBuilder |
|
getMimeType()
public String getMimeType()Optional. Specifies the translated document's mime_type. If not specified, the translated file's mime type will be the same as the input file's mime type. Currently only support the output mime type to be the same as input mime type.
- application/pdf
- application/vnd.openxmlformats-officedocument.wordprocessingml.document
- application/vnd.openxmlformats-officedocument.presentationml.presentation
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The mimeType. |
getMimeTypeBytes()
public ByteString getMimeTypeBytes()Optional. Specifies the translated document's mime_type. If not specified, the translated file's mime type will be the same as the input file's mime type. Currently only support the output mime type to be the same as input mime type.
- application/pdf
- application/vnd.openxmlformats-officedocument.wordprocessingml.document
- application/vnd.openxmlformats-officedocument.presentationml.presentation
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for mimeType. |
hasGcsDestination()
public boolean hasGcsDestination() Optional. Google Cloud Storage destination for the translation output,
e.g., gs://my_bucket/my_directory/.
The destination directory provided does not have to be empty, but the bucket must exist. If a file with the same name as the output file already exists in the destination an error will be returned.
For a DocumentInputConfig.contents provided document, the output file will have the name "output_[trg]_translations.[ext]", where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension according to its mime type.
For a DocumentInputConfig.gcs_uri provided document, the output file will
have a name according to its URI. For example: an input file with URI:
gs://a/b/c.[extension] stored in a gcs_destination bucket with name
"my_bucket" will have an output URI:
gs://my_bucket/a_b_c_[trg]_translations.[ext], where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension according to its mime type.
If the document was directly provided through the request, then the
output document will have the format:
gs://my_bucket/translated_document_[trg]_translations.[ext], where
- [trg] corresponds to the translated file's language code,
[ext] corresponds to the translated file's extension according to its mime type.
If a glossary was provided, then the output URI for the glossary translation will be equal to the default output URI but have
glossary_translationsinstead oftranslations. For the previous example, its glossary URI would be:gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext].Thus the max number of output files will be 2 (Translated document, Glossary translated document).
Callers should expect no partial outputs. If there is any error during document translation, no output will be stored in the Cloud Storage bucket.
.google.cloud.translation.v3.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the gcsDestination field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(DocumentOutputConfig other)
public DocumentOutputConfig.Builder mergeFrom(DocumentOutputConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
DocumentOutputConfig |
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DocumentOutputConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public DocumentOutputConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|
mergeGcsDestination(GcsDestination value)
public DocumentOutputConfig.Builder mergeGcsDestination(GcsDestination value) Optional. Google Cloud Storage destination for the translation output,
e.g., gs://my_bucket/my_directory/.
The destination directory provided does not have to be empty, but the bucket must exist. If a file with the same name as the output file already exists in the destination an error will be returned.
For a DocumentInputConfig.contents provided document, the output file will have the name "output_[trg]_translations.[ext]", where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension according to its mime type.
For a DocumentInputConfig.gcs_uri provided document, the output file will
have a name according to its URI. For example: an input file with URI:
gs://a/b/c.[extension] stored in a gcs_destination bucket with name
"my_bucket" will have an output URI:
gs://my_bucket/a_b_c_[trg]_translations.[ext], where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension according to its mime type.
If the document was directly provided through the request, then the
output document will have the format:
gs://my_bucket/translated_document_[trg]_translations.[ext], where
- [trg] corresponds to the translated file's language code,
[ext] corresponds to the translated file's extension according to its mime type.
If a glossary was provided, then the output URI for the glossary translation will be equal to the default output URI but have
glossary_translationsinstead oftranslations. For the previous example, its glossary URI would be:gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext].Thus the max number of output files will be 2 (Translated document, Glossary translated document).
Callers should expect no partial outputs. If there is any error during document translation, no output will be stored in the Cloud Storage bucket.
.google.cloud.translation.v3.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
GcsDestination |
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DocumentOutputConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public DocumentOutputConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|
setGcsDestination(GcsDestination value)
public DocumentOutputConfig.Builder setGcsDestination(GcsDestination value) Optional. Google Cloud Storage destination for the translation output,
e.g., gs://my_bucket/my_directory/.
The destination directory provided does not have to be empty, but the bucket must exist. If a file with the same name as the output file already exists in the destination an error will be returned.
For a DocumentInputConfig.contents provided document, the output file will have the name "output_[trg]_translations.[ext]", where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension according to its mime type.
For a DocumentInputConfig.gcs_uri provided document, the output file will
have a name according to its URI. For example: an input file with URI:
gs://a/b/c.[extension] stored in a gcs_destination bucket with name
"my_bucket" will have an output URI:
gs://my_bucket/a_b_c_[trg]_translations.[ext], where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension according to its mime type.
If the document was directly provided through the request, then the
output document will have the format:
gs://my_bucket/translated_document_[trg]_translations.[ext], where
- [trg] corresponds to the translated file's language code,
[ext] corresponds to the translated file's extension according to its mime type.
If a glossary was provided, then the output URI for the glossary translation will be equal to the default output URI but have
glossary_translationsinstead oftranslations. For the previous example, its glossary URI would be:gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext].Thus the max number of output files will be 2 (Translated document, Glossary translated document).
Callers should expect no partial outputs. If there is any error during document translation, no output will be stored in the Cloud Storage bucket.
.google.cloud.translation.v3.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
GcsDestination |
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|
setGcsDestination(GcsDestination.Builder builderForValue)
public DocumentOutputConfig.Builder setGcsDestination(GcsDestination.Builder builderForValue) Optional. Google Cloud Storage destination for the translation output,
e.g., gs://my_bucket/my_directory/.
The destination directory provided does not have to be empty, but the bucket must exist. If a file with the same name as the output file already exists in the destination an error will be returned.
For a DocumentInputConfig.contents provided document, the output file will have the name "output_[trg]_translations.[ext]", where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension according to its mime type.
For a DocumentInputConfig.gcs_uri provided document, the output file will
have a name according to its URI. For example: an input file with URI:
gs://a/b/c.[extension] stored in a gcs_destination bucket with name
"my_bucket" will have an output URI:
gs://my_bucket/a_b_c_[trg]_translations.[ext], where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension according to its mime type.
If the document was directly provided through the request, then the
output document will have the format:
gs://my_bucket/translated_document_[trg]_translations.[ext], where
- [trg] corresponds to the translated file's language code,
[ext] corresponds to the translated file's extension according to its mime type.
If a glossary was provided, then the output URI for the glossary translation will be equal to the default output URI but have
glossary_translationsinstead oftranslations. For the previous example, its glossary URI would be:gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext].Thus the max number of output files will be 2 (Translated document, Glossary translated document).
Callers should expect no partial outputs. If there is any error during document translation, no output will be stored in the Cloud Storage bucket.
.google.cloud.translation.v3.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
GcsDestination.Builder |
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|
setMimeType(String value)
public DocumentOutputConfig.Builder setMimeType(String value)Optional. Specifies the translated document's mime_type. If not specified, the translated file's mime type will be the same as the input file's mime type. Currently only support the output mime type to be the same as input mime type.
- application/pdf
- application/vnd.openxmlformats-officedocument.wordprocessingml.document
- application/vnd.openxmlformats-officedocument.presentationml.presentation
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe mimeType to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
This builder for chaining. |
setMimeTypeBytes(ByteString value)
public DocumentOutputConfig.Builder setMimeTypeBytes(ByteString value)Optional. Specifies the translated document's mime_type. If not specified, the translated file's mime type will be the same as the input file's mime type. Currently only support the output mime type to be the same as input mime type.
- application/pdf
- application/vnd.openxmlformats-officedocument.wordprocessingml.document
- application/vnd.openxmlformats-officedocument.presentationml.presentation
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for mimeType to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DocumentOutputConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final DocumentOutputConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DocumentOutputConfig.Builder |
|