public final class BatchDocumentOutputConfig extends GeneratedMessageV3 implements BatchDocumentOutputConfigOrBuilder
Output configuration for BatchTranslateDocument request.
Protobuf type google.cloud.translation.v3.BatchDocumentOutputConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
GCS_DESTINATION_FIELD_NUMBER
public static final int GCS_DESTINATION_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static BatchDocumentOutputConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BatchDocumentOutputConfig.Builder newBuilder()
newBuilder(BatchDocumentOutputConfig prototype)
public static BatchDocumentOutputConfig.Builder newBuilder(BatchDocumentOutputConfig prototype)
public static BatchDocumentOutputConfig parseDelimitedFrom(InputStream input)
public static BatchDocumentOutputConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BatchDocumentOutputConfig parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchDocumentOutputConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BatchDocumentOutputConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchDocumentOutputConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchDocumentOutputConfig parseFrom(CodedInputStream input)
public static BatchDocumentOutputConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchDocumentOutputConfig parseFrom(InputStream input)
public static BatchDocumentOutputConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BatchDocumentOutputConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BatchDocumentOutputConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BatchDocumentOutputConfig> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public BatchDocumentOutputConfig getDefaultInstanceForType()
getDestinationCase()
public BatchDocumentOutputConfig.DestinationCase getDestinationCase()
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#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;
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#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;
getParserForType()
public Parser<BatchDocumentOutputConfig> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
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#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;
Returns |
Type |
Description |
boolean |
Whether the gcsDestination field is set.
|
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public BatchDocumentOutputConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BatchDocumentOutputConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public BatchDocumentOutputConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides