com.google.cloud.translate.v3

Class DocumentOutputConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.translate.v3.DocumentOutputConfig

All Implemented Interfaces:

DocumentOutputConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class DocumentOutputConfig
extends com.google.protobuf.GeneratedMessageV3
implements DocumentOutputConfigOrBuilder

 A document translation request output config.
 

Protobuf type google.cloud.translation.v3.DocumentOutputConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentOutputConfig.Builder A document translation request output config.
static class	DocumentOutputConfig.DestinationCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	GCS_DESTINATION_FIELD_NUMBER
static int	MIME_TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static DocumentOutputConfig	getDefaultInstance()
DocumentOutputConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
DocumentOutputConfig.DestinationCase	getDestinationCase()
GcsDestination	getGcsDestination() Optional.
GcsDestinationOrBuilder	getGcsDestinationOrBuilder() Optional.
String	getMimeType() Optional.
com.google.protobuf.ByteString	getMimeTypeBytes() Optional.
com.google.protobuf.Parser<DocumentOutputConfig>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasGcsDestination() Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DocumentOutputConfig.Builder	newBuilder()
static DocumentOutputConfig.Builder	newBuilder(DocumentOutputConfig prototype)
DocumentOutputConfig.Builder	newBuilderForType()
protected DocumentOutputConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DocumentOutputConfig	parseDelimitedFrom(InputStream input)
static DocumentOutputConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentOutputConfig	parseFrom(byte[] data)
static DocumentOutputConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentOutputConfig	parseFrom(ByteBuffer data)
static DocumentOutputConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentOutputConfig	parseFrom(com.google.protobuf.ByteString data)
static DocumentOutputConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentOutputConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static DocumentOutputConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentOutputConfig	parseFrom(InputStream input)
static DocumentOutputConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DocumentOutputConfig>	parser()
DocumentOutputConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

GCS_DESTINATION_FIELD_NUMBER

public static final int GCS_DESTINATION_FIELD_NUMBER

See Also:

Constant Field Values

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getDestinationCase

public DocumentOutputConfig.DestinationCase getDestinationCase()

Specified by:

getDestinationCase in interface DocumentOutputConfigOrBuilder

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

Specified by:

hasGcsDestination in interface DocumentOutputConfigOrBuilder

Returns:

Whether the gcsDestination field is set.

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

Specified by:

getGcsDestination in interface DocumentOutputConfigOrBuilder

Returns:

The gcsDestination.

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

Specified by:

getGcsDestinationOrBuilder in interface DocumentOutputConfigOrBuilder

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

Specified by:

getMimeType in interface DocumentOutputConfigOrBuilder

Returns:

The mimeType.

getMimeTypeBytes

public com.google.protobuf.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];

Specified by:

getMimeTypeBytes in interface DocumentOutputConfigOrBuilder

Returns:

The bytes for mimeType.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static DocumentOutputConfig parseFrom(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentOutputConfig parseFrom(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentOutputConfig parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentOutputConfig parseFrom(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentOutputConfig parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentOutputConfig parseFrom(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentOutputConfig parseFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static DocumentOutputConfig parseFrom(InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static DocumentOutputConfig parseDelimitedFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static DocumentOutputConfig parseDelimitedFrom(InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseFrom

public static DocumentOutputConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static DocumentOutputConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

newBuilderForType

public DocumentOutputConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DocumentOutputConfig.Builder newBuilder()

newBuilder

public static DocumentOutputConfig.Builder newBuilder(DocumentOutputConfig prototype)

toBuilder

public DocumentOutputConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DocumentOutputConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DocumentOutputConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<DocumentOutputConfig> parser()

getParserForType

public com.google.protobuf.Parser<DocumentOutputConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public DocumentOutputConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder