public final class DocumentOutputConfig extends GeneratedMessageV3 implements DocumentOutputConfigOrBuilder
A document translation request output config.
Protobuf type google.cloud.translation.v3beta1.DocumentOutputConfig
Static Fields
GCS_DESTINATION_FIELD_NUMBER
public static final int GCS_DESTINATION_FIELD_NUMBER
Field Value
MIME_TYPE_FIELD_NUMBER
public static final int MIME_TYPE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static DocumentOutputConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static DocumentOutputConfig.Builder newBuilder()
Returns
newBuilder(DocumentOutputConfig prototype)
public static DocumentOutputConfig.Builder newBuilder(DocumentOutputConfig prototype)
Parameter
Returns
public static DocumentOutputConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DocumentOutputConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DocumentOutputConfig parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DocumentOutputConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DocumentOutputConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentOutputConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DocumentOutputConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DocumentOutputConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DocumentOutputConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DocumentOutputConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DocumentOutputConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DocumentOutputConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<DocumentOutputConfig> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public DocumentOutputConfig getDefaultInstanceForType()
Returns
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.v3beta1.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];
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.v3beta1.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];
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];
| 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];
getParserForType()
public Parser<DocumentOutputConfig> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.v3beta1.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the gcsDestination field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public DocumentOutputConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DocumentOutputConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public DocumentOutputConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
