public static final class DocumentOutputConfig.Builder extends GeneratedMessageV3.Builder<DocumentOutputConfig.Builder> implements DocumentOutputConfigOrBuilder
A document translation request output config.
Protobuf type google.cloud.translation.v3.DocumentOutputConfig
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DocumentOutputConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public DocumentOutputConfig build()
Returns
buildPartial()
public DocumentOutputConfig buildPartial()
Returns
clear()
public DocumentOutputConfig.Builder clear()
Returns
Overrides
clearDestination()
public DocumentOutputConfig.Builder clearDestination()
Returns
clearField(Descriptors.FieldDescriptor field)
public DocumentOutputConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
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_translations
instead of translations
. 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
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
clearOneof(Descriptors.OneofDescriptor oneof)
public DocumentOutputConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clone()
public DocumentOutputConfig.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public DocumentOutputConfig getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getDestinationCase()
public DocumentOutputConfig.DestinationCase getDestinationCase()
Returns
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_translations
instead of translations
. 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
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_translations
instead of translations
. 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
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_translations
instead of translations
. 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
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
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_translations
instead of translations
. 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
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(DocumentOutputConfig other)
public DocumentOutputConfig.Builder mergeFrom(DocumentOutputConfig other)
Parameter
Returns
public DocumentOutputConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public DocumentOutputConfig.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
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_translations
instead of translations
. 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
Returns
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DocumentOutputConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public DocumentOutputConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
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_translations
instead of translations
. 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
Returns
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_translations
instead of translations
. 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
Returns
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 | String
The mimeType to set.
|
Returns
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 | ByteString
The bytes for mimeType to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DocumentOutputConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final DocumentOutputConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides