com.google.cloud.translate.v3

Class BatchDocumentOutputConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.translate.v3.BatchDocumentOutputConfig

All Implemented Interfaces:

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

public final class BatchDocumentOutputConfig
extends com.google.protobuf.GeneratedMessageV3
implements BatchDocumentOutputConfigOrBuilder

 Output configuration for BatchTranslateDocument request.
 

Protobuf type google.cloud.translation.v3.BatchDocumentOutputConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchDocumentOutputConfig.Builder Output configuration for BatchTranslateDocument request.
static class	BatchDocumentOutputConfig.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

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 BatchDocumentOutputConfig	getDefaultInstance()
BatchDocumentOutputConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
BatchDocumentOutputConfig.DestinationCase	getDestinationCase()
GcsDestination	getGcsDestination() Google Cloud Storage destination for output content.
GcsDestinationOrBuilder	getGcsDestinationOrBuilder() Google Cloud Storage destination for output content.
com.google.protobuf.Parser<BatchDocumentOutputConfig>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasGcsDestination() Google Cloud Storage destination for output content.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static BatchDocumentOutputConfig.Builder	newBuilder()
static BatchDocumentOutputConfig.Builder	newBuilder(BatchDocumentOutputConfig prototype)
BatchDocumentOutputConfig.Builder	newBuilderForType()
protected BatchDocumentOutputConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static BatchDocumentOutputConfig	parseDelimitedFrom(InputStream input)
static BatchDocumentOutputConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchDocumentOutputConfig	parseFrom(byte[] data)
static BatchDocumentOutputConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchDocumentOutputConfig	parseFrom(ByteBuffer data)
static BatchDocumentOutputConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchDocumentOutputConfig	parseFrom(com.google.protobuf.ByteString data)
static BatchDocumentOutputConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchDocumentOutputConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static BatchDocumentOutputConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchDocumentOutputConfig	parseFrom(InputStream input)
static BatchDocumentOutputConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BatchDocumentOutputConfig>	parser()
BatchDocumentOutputConfig.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

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 BatchDocumentOutputConfig.DestinationCase getDestinationCase()

Specified by:

getDestinationCase in interface BatchDocumentOutputConfigOrBuilder

hasGcsDestination

public boolean hasGcsDestination()

 Google Cloud Storage destination for output content.
 For every single input document (for example, gs://a/b/c.[extension]), we
 generate at most 2 * n output files. (n is the # of target_language_codes
 in the BatchTranslateDocumentRequest).
 While the input documents are being processed, we write/update an index
 file `index.csv` under `gcs_destination.output_uri_prefix` (for example,
 gs://translation_output/index.csv) The index file is generated/updated as
 new files are being translated. The format is:
 input_document,target_language_code,translation_output,error_output,
 glossary_translation_output,glossary_error_output
 `input_document` is one file we matched using gcs_source.input_uri.
 `target_language_code` is provided in the request.
 `translation_output` contains the translations. (details provided below)
 `error_output` contains the error message during processing of the file.
 Both translations_file and errors_file could be empty strings if we have
 no content to output.
 `glossary_translation_output` and `glossary_error_output` are the
 translated output/error when we apply glossaries. They could also be
 empty if we have no content to output.
 Once a row is present in index.csv, the input/output matching never
 changes. Callers should also expect all the content in input_file are
 processed and ready to be consumed (that is, no partial output file is
 written).
 Since index.csv will be keeping updated during the process, please make
 sure there is no custom retention policy applied on the output bucket
 that may avoid file updating.
 (https://cloud.google.com/storage/docs/bucket-lock?hl=en#retention-policy)
 The naming format of translation output files follows (for target
 language code [trg]): `translation_output`:
 gs://translation_output/a_b_c_[trg]_translation.[extension]
 `glossary_translation_output`:
 gs://translation_test/a_b_c_[trg]_glossary_translation.[extension] The
 output document will maintain the same file format as the input document.
 The naming format of error output files follows (for target language code
 [trg]): `error_output`: gs://translation_test/a_b_c_[trg]_errors.txt
 `glossary_error_output`:
 gs://translation_test/a_b_c_[trg]_glossary_translation.txt The error
 output is a txt file containing error details.
 

.google.cloud.translation.v3.GcsDestination gcs_destination = 1;

Specified by:

hasGcsDestination in interface BatchDocumentOutputConfigOrBuilder

Returns:

Whether the gcsDestination field is set.

getGcsDestination

public GcsDestination getGcsDestination()

 Google Cloud Storage destination for output content.
 For every single input document (for example, gs://a/b/c.[extension]), we
 generate at most 2 * n output files. (n is the # of target_language_codes
 in the BatchTranslateDocumentRequest).
 While the input documents are being processed, we write/update an index
 file `index.csv` under `gcs_destination.output_uri_prefix` (for example,
 gs://translation_output/index.csv) The index file is generated/updated as
 new files are being translated. The format is:
 input_document,target_language_code,translation_output,error_output,
 glossary_translation_output,glossary_error_output
 `input_document` is one file we matched using gcs_source.input_uri.
 `target_language_code` is provided in the request.
 `translation_output` contains the translations. (details provided below)
 `error_output` contains the error message during processing of the file.
 Both translations_file and errors_file could be empty strings if we have
 no content to output.
 `glossary_translation_output` and `glossary_error_output` are the
 translated output/error when we apply glossaries. They could also be
 empty if we have no content to output.
 Once a row is present in index.csv, the input/output matching never
 changes. Callers should also expect all the content in input_file are
 processed and ready to be consumed (that is, no partial output file is
 written).
 Since index.csv will be keeping updated during the process, please make
 sure there is no custom retention policy applied on the output bucket
 that may avoid file updating.
 (https://cloud.google.com/storage/docs/bucket-lock?hl=en#retention-policy)
 The naming format of translation output files follows (for target
 language code [trg]): `translation_output`:
 gs://translation_output/a_b_c_[trg]_translation.[extension]
 `glossary_translation_output`:
 gs://translation_test/a_b_c_[trg]_glossary_translation.[extension] The
 output document will maintain the same file format as the input document.
 The naming format of error output files follows (for target language code
 [trg]): `error_output`: gs://translation_test/a_b_c_[trg]_errors.txt
 `glossary_error_output`:
 gs://translation_test/a_b_c_[trg]_glossary_translation.txt The error
 output is a txt file containing error details.
 

.google.cloud.translation.v3.GcsDestination gcs_destination = 1;

Specified by:

getGcsDestination in interface BatchDocumentOutputConfigOrBuilder

Returns:

The gcsDestination.

getGcsDestinationOrBuilder

public GcsDestinationOrBuilder getGcsDestinationOrBuilder()

 Google Cloud Storage destination for output content.
 For every single input document (for example, gs://a/b/c.[extension]), we
 generate at most 2 * n output files. (n is the # of target_language_codes
 in the BatchTranslateDocumentRequest).
 While the input documents are being processed, we write/update an index
 file `index.csv` under `gcs_destination.output_uri_prefix` (for example,
 gs://translation_output/index.csv) The index file is generated/updated as
 new files are being translated. The format is:
 input_document,target_language_code,translation_output,error_output,
 glossary_translation_output,glossary_error_output
 `input_document` is one file we matched using gcs_source.input_uri.
 `target_language_code` is provided in the request.
 `translation_output` contains the translations. (details provided below)
 `error_output` contains the error message during processing of the file.
 Both translations_file and errors_file could be empty strings if we have
 no content to output.
 `glossary_translation_output` and `glossary_error_output` are the
 translated output/error when we apply glossaries. They could also be
 empty if we have no content to output.
 Once a row is present in index.csv, the input/output matching never
 changes. Callers should also expect all the content in input_file are
 processed and ready to be consumed (that is, no partial output file is
 written).
 Since index.csv will be keeping updated during the process, please make
 sure there is no custom retention policy applied on the output bucket
 that may avoid file updating.
 (https://cloud.google.com/storage/docs/bucket-lock?hl=en#retention-policy)
 The naming format of translation output files follows (for target
 language code [trg]): `translation_output`:
 gs://translation_output/a_b_c_[trg]_translation.[extension]
 `glossary_translation_output`:
 gs://translation_test/a_b_c_[trg]_glossary_translation.[extension] The
 output document will maintain the same file format as the input document.
 The naming format of error output files follows (for target language code
 [trg]): `error_output`: gs://translation_test/a_b_c_[trg]_errors.txt
 `glossary_error_output`:
 gs://translation_test/a_b_c_[trg]_glossary_translation.txt The error
 output is a txt file containing error details.
 

.google.cloud.translation.v3.GcsDestination gcs_destination = 1;

Specified by:

getGcsDestinationOrBuilder in interface BatchDocumentOutputConfigOrBuilder

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 BatchDocumentOutputConfig parseFrom(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchDocumentOutputConfig parseFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static BatchDocumentOutputConfig parseDelimitedFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public BatchDocumentOutputConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static BatchDocumentOutputConfig.Builder newBuilder()

newBuilder

public static BatchDocumentOutputConfig.Builder newBuilder(BatchDocumentOutputConfig prototype)

toBuilder

public BatchDocumentOutputConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static BatchDocumentOutputConfig getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<BatchDocumentOutputConfig> 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 BatchDocumentOutputConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder