Package com.google.cloud.translate.v3beta1

Class OutputConfig

  • All Implemented Interfaces:
    OutputConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class OutputConfig
extends com.google.protobuf.GeneratedMessageV3
implements OutputConfigOrBuilder
     Output configuration for BatchTranslateText request.
    Protobuf type google.cloud.translation.v3beta1.OutputConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  OutputConfig.Builder
      Output configuration for BatchTranslateText request.
      static class  OutputConfig.DestinationCase  

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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 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

    • 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

      • 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

      • hasGcsDestination

        public boolean hasGcsDestination()
         Google Cloud Storage destination for output content.
 For every single input file (for example, gs://a/b/c.[extension]), we
 generate at most 2 * n output files. (n is the # of target_language_codes
 in the BatchTranslateTextRequest).

 Output files (tsv) generated are compliant with RFC 4180 except that
 record delimiters are '\n' instead of '\r\n'. We don't provide any way to
 change record delimiters.

 While the input files are being processed, we write/update an index file
 'index.csv'  under 'output_uri_prefix' (for example,
 gs://translation-test/index.csv) The index file is generated/updated as
 new files are being translated. The format is:

 input_file,target_language_code,translations_file,errors_file,
 glossary_translations_file,glossary_errors_file

 input_file is one file we matched using gcs_source.input_uri.
 target_language_code is provided in the request.
 translations_file contains the translations. (details provided below)
 errors_file contains the errors during processing of the file. (details
 below). Both translations_file and errors_file could be empty
 strings if we have no content to output.
 glossary_translations_file and glossary_errors_file are always empty
 strings if the input_file is tsv. 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 format of translations_file (for target language code 'trg') is:
 `gs://translation_test/a_b_c_'trg'_translations.[extension]`

 If the input file extension is tsv, the output has the following
 columns:
 Column 1: ID of the request provided in the input, if it's not
 provided in the input, then the input row number is used (0-based).
 Column 2: source sentence.
 Column 3: translation without applying a glossary. Empty string if there
 is an error.
 Column 4 (only present if a glossary is provided in the request):
 translation after applying the glossary. Empty string if there is an
 error applying the glossary. Could be same string as column 3 if there is
 no glossary applied.

 If input file extension is a txt or html, the translation is directly
 written to the output file. If glossary is requested, a separate
 glossary_translations_file has format of
 `gs://translation_test/a_b_c_'trg'_glossary_translations.[extension]`

 The format of errors file (for target language code 'trg') is:
 `gs://translation_test/a_b_c_'trg'_errors.[extension]`

 If the input file extension is tsv, errors_file contains the following:
 Column 1: ID of the request provided in the input, if it's not
 provided in the input, then the input row number is used (0-based).
 Column 2: source sentence.
 Column 3: Error detail for the translation. Could be empty.
 Column 4 (only present if a glossary is provided in the request):
 Error when applying the glossary.

 If the input file extension is txt or html, glossary_error_file will be
 generated that contains error details. glossary_error_file has format of
 `gs://translation_test/a_b_c_'trg'_glossary_errors.[extension]`
        .google.cloud.translation.v3beta1.GcsDestination gcs_destination = 1;
        Specified by:
        hasGcsDestination in interface OutputConfigOrBuilder
        Returns:
        Whether the gcsDestination field is set.

      • getGcsDestination

        public GcsDestination getGcsDestination()
         Google Cloud Storage destination for output content.
 For every single input file (for example, gs://a/b/c.[extension]), we
 generate at most 2 * n output files. (n is the # of target_language_codes
 in the BatchTranslateTextRequest).

 Output files (tsv) generated are compliant with RFC 4180 except that
 record delimiters are '\n' instead of '\r\n'. We don't provide any way to
 change record delimiters.

 While the input files are being processed, we write/update an index file
 'index.csv'  under 'output_uri_prefix' (for example,
 gs://translation-test/index.csv) The index file is generated/updated as
 new files are being translated. The format is:

 input_file,target_language_code,translations_file,errors_file,
 glossary_translations_file,glossary_errors_file

 input_file is one file we matched using gcs_source.input_uri.
 target_language_code is provided in the request.
 translations_file contains the translations. (details provided below)
 errors_file contains the errors during processing of the file. (details
 below). Both translations_file and errors_file could be empty
 strings if we have no content to output.
 glossary_translations_file and glossary_errors_file are always empty
 strings if the input_file is tsv. 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 format of translations_file (for target language code 'trg') is:
 `gs://translation_test/a_b_c_'trg'_translations.[extension]`

 If the input file extension is tsv, the output has the following
 columns:
 Column 1: ID of the request provided in the input, if it's not
 provided in the input, then the input row number is used (0-based).
 Column 2: source sentence.
 Column 3: translation without applying a glossary. Empty string if there
 is an error.
 Column 4 (only present if a glossary is provided in the request):
 translation after applying the glossary. Empty string if there is an
 error applying the glossary. Could be same string as column 3 if there is
 no glossary applied.

 If input file extension is a txt or html, the translation is directly
 written to the output file. If glossary is requested, a separate
 glossary_translations_file has format of
 `gs://translation_test/a_b_c_'trg'_glossary_translations.[extension]`

 The format of errors file (for target language code 'trg') is:
 `gs://translation_test/a_b_c_'trg'_errors.[extension]`

 If the input file extension is tsv, errors_file contains the following:
 Column 1: ID of the request provided in the input, if it's not
 provided in the input, then the input row number is used (0-based).
 Column 2: source sentence.
 Column 3: Error detail for the translation. Could be empty.
 Column 4 (only present if a glossary is provided in the request):
 Error when applying the glossary.

 If the input file extension is txt or html, glossary_error_file will be
 generated that contains error details. glossary_error_file has format of
 `gs://translation_test/a_b_c_'trg'_glossary_errors.[extension]`
        .google.cloud.translation.v3beta1.GcsDestination gcs_destination = 1;
        Specified by:
        getGcsDestination in interface OutputConfigOrBuilder
        Returns:
        The gcsDestination.

      • getGcsDestinationOrBuilder

        public GcsDestinationOrBuilder getGcsDestinationOrBuilder()
         Google Cloud Storage destination for output content.
 For every single input file (for example, gs://a/b/c.[extension]), we
 generate at most 2 * n output files. (n is the # of target_language_codes
 in the BatchTranslateTextRequest).

 Output files (tsv) generated are compliant with RFC 4180 except that
 record delimiters are '\n' instead of '\r\n'. We don't provide any way to
 change record delimiters.

 While the input files are being processed, we write/update an index file
 'index.csv'  under 'output_uri_prefix' (for example,
 gs://translation-test/index.csv) The index file is generated/updated as
 new files are being translated. The format is:

 input_file,target_language_code,translations_file,errors_file,
 glossary_translations_file,glossary_errors_file

 input_file is one file we matched using gcs_source.input_uri.
 target_language_code is provided in the request.
 translations_file contains the translations. (details provided below)
 errors_file contains the errors during processing of the file. (details
 below). Both translations_file and errors_file could be empty
 strings if we have no content to output.
 glossary_translations_file and glossary_errors_file are always empty
 strings if the input_file is tsv. 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 format of translations_file (for target language code 'trg') is:
 `gs://translation_test/a_b_c_'trg'_translations.[extension]`

 If the input file extension is tsv, the output has the following
 columns:
 Column 1: ID of the request provided in the input, if it's not
 provided in the input, then the input row number is used (0-based).
 Column 2: source sentence.
 Column 3: translation without applying a glossary. Empty string if there
 is an error.
 Column 4 (only present if a glossary is provided in the request):
 translation after applying the glossary. Empty string if there is an
 error applying the glossary. Could be same string as column 3 if there is
 no glossary applied.

 If input file extension is a txt or html, the translation is directly
 written to the output file. If glossary is requested, a separate
 glossary_translations_file has format of
 `gs://translation_test/a_b_c_'trg'_glossary_translations.[extension]`

 The format of errors file (for target language code 'trg') is:
 `gs://translation_test/a_b_c_'trg'_errors.[extension]`

 If the input file extension is tsv, errors_file contains the following:
 Column 1: ID of the request provided in the input, if it's not
 provided in the input, then the input row number is used (0-based).
 Column 2: source sentence.
 Column 3: Error detail for the translation. Could be empty.
 Column 4 (only present if a glossary is provided in the request):
 Error when applying the glossary.

 If the input file extension is txt or html, glossary_error_file will be
 generated that contains error details. glossary_error_file has format of
 `gs://translation_test/a_b_c_'trg'_glossary_errors.[extension]`
        .google.cloud.translation.v3beta1.GcsDestination gcs_destination = 1;
        Specified by:
        getGcsDestinationOrBuilder in interface OutputConfigOrBuilder

      • 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 OutputConfig parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OutputConfig parseFrom​(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OutputConfig parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OutputConfig parseFrom​(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OutputConfig parseFrom​(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OutputConfig parseFrom​(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OutputConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • newBuilderForType

        public OutputConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public OutputConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected OutputConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static OutputConfig getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<OutputConfig> 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 OutputConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder