public static final class BatchDocumentOutputConfig.Builder extends GeneratedMessageV3.Builder<BatchDocumentOutputConfig.Builder> implements BatchDocumentOutputConfigOrBuilder
Output configuration for BatchTranslateDocument request.
Protobuf type google.cloud.translation.v3beta1.BatchDocumentOutputConfig
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public BatchDocumentOutputConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public BatchDocumentOutputConfig build()
Returns
buildPartial()
public BatchDocumentOutputConfig buildPartial()
Returns
clear()
public BatchDocumentOutputConfig.Builder clear()
Returns
Overrides
clearDestination()
public BatchDocumentOutputConfig.Builder clearDestination()
Returns
clearField(Descriptors.FieldDescriptor field)
public BatchDocumentOutputConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearGcsDestination()
public BatchDocumentOutputConfig.Builder clearGcsDestination()
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.v3beta1.GcsDestination gcs_destination = 1;
clearOneof(Descriptors.OneofDescriptor oneof)
public BatchDocumentOutputConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clone()
public BatchDocumentOutputConfig.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public BatchDocumentOutputConfig getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getDestinationCase()
public BatchDocumentOutputConfig.DestinationCase getDestinationCase()
Returns
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.v3beta1.GcsDestination gcs_destination = 1;
getGcsDestinationBuilder()
public GcsDestination.Builder getGcsDestinationBuilder()
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.v3beta1.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?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.v3beta1.GcsDestination gcs_destination = 1;
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.v3beta1.GcsDestination gcs_destination = 1;
| Type | Description |
| boolean | Whether the gcsDestination field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(BatchDocumentOutputConfig other)
public BatchDocumentOutputConfig.Builder mergeFrom(BatchDocumentOutputConfig other)
Parameter
Returns
public BatchDocumentOutputConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public BatchDocumentOutputConfig.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeGcsDestination(GcsDestination value)
public BatchDocumentOutputConfig.Builder mergeGcsDestination(GcsDestination value)
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.v3beta1.GcsDestination gcs_destination = 1;
mergeUnknownFields(UnknownFieldSet unknownFields)
public final BatchDocumentOutputConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public BatchDocumentOutputConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setGcsDestination(GcsDestination value)
public BatchDocumentOutputConfig.Builder setGcsDestination(GcsDestination value)
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.v3beta1.GcsDestination gcs_destination = 1;
setGcsDestination(GcsDestination.Builder builderForValue)
public BatchDocumentOutputConfig.Builder setGcsDestination(GcsDestination.Builder builderForValue)
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.v3beta1.GcsDestination gcs_destination = 1;
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public BatchDocumentOutputConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final BatchDocumentOutputConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
