Package com.google.cloud.translate.v3

Class BatchDocumentOutputConfig.Builder

    • Method Detail

      • 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.Builder<BatchDocumentOutputConfig.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<BatchDocumentOutputConfig.Builder>

      • getDefaultInstanceForType

        public BatchDocumentOutputConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public BatchDocumentOutputConfig build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public BatchDocumentOutputConfig buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • setRepeatedField

        public BatchDocumentOutputConfig.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          int index,
                                                          Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchDocumentOutputConfig.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<BatchDocumentOutputConfig.Builder>

      • mergeFrom

        public BatchDocumentOutputConfig.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BatchDocumentOutputConfig.Builder>
        Throws:
        IOException

      • 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;
        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#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.

      • setGcsDestination

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

      • setGcsDestination

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

      • mergeGcsDestination

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

      • 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#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;

      • 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#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;
        Specified by:
        getGcsDestinationOrBuilder in interface BatchDocumentOutputConfigOrBuilder

      • setUnknownFields

        public final BatchDocumentOutputConfig.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BatchDocumentOutputConfig.Builder>

      • mergeUnknownFields

        public final BatchDocumentOutputConfig.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BatchDocumentOutputConfig.Builder>