Package com.google.cloud.translate.v3

Class DocumentOutputConfig.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<DocumentOutputConfig.Builder>

      • clear

        public DocumentOutputConfig.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentOutputConfig.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<DocumentOutputConfig.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public DocumentOutputConfig.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentOutputConfig.Builder>

      • setField

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

      • clearField

        public DocumentOutputConfig.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentOutputConfig.Builder>

      • clearOneof

        public DocumentOutputConfig.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentOutputConfig.Builder>

      • setRepeatedField

        public DocumentOutputConfig.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<DocumentOutputConfig.Builder>

      • addRepeatedField

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

      • isInitialized

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

      • mergeFrom

        public DocumentOutputConfig.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<DocumentOutputConfig.Builder>
        Throws:
        IOException

      • hasGcsDestination

        public boolean hasGcsDestination()
         Optional. Google Cloud Storage destination for the translation output,
 e.g., `gs://my_bucket/my_directory/`.

 The destination directory provided does not have to be empty, but the
 bucket must exist. If a file with the same name as the output file
 already exists in the destination an error will be returned.

 For a DocumentInputConfig.contents provided document, the output file
 will have the name "output_[trg]_translations.[ext]", where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.


 For a DocumentInputConfig.gcs_uri provided document, the output file will
 have a name according to its URI. For example: an input file with URI:
 `gs://a/b/c.[extension]` stored in a gcs_destination bucket with name
 "my_bucket" will have an output URI:
 `gs://my_bucket/a_b_c_[trg]_translations.[ext]`, where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.


 If the document was directly provided through the request, then the
 output document will have the format:
 `gs://my_bucket/translated_document_[trg]_translations.[ext]`, where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.

 If a glossary was provided, then the output URI for the glossary
 translation will be equal to the default output URI but have
 `glossary_translations` instead of `translations`. For the previous
 example, its glossary URI would be:
 `gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext]`.

 Thus the max number of output files will be 2 (Translated document,
 Glossary translated document).

 Callers should expect no partial outputs. If there is any error during
 document translation, no output will be stored in the Cloud Storage
 bucket.
        .google.cloud.translation.v3.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasGcsDestination in interface DocumentOutputConfigOrBuilder
        Returns:
        Whether the gcsDestination field is set.

      • getGcsDestination

        public GcsDestination getGcsDestination()
         Optional. Google Cloud Storage destination for the translation output,
 e.g., `gs://my_bucket/my_directory/`.

 The destination directory provided does not have to be empty, but the
 bucket must exist. If a file with the same name as the output file
 already exists in the destination an error will be returned.

 For a DocumentInputConfig.contents provided document, the output file
 will have the name "output_[trg]_translations.[ext]", where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.


 For a DocumentInputConfig.gcs_uri provided document, the output file will
 have a name according to its URI. For example: an input file with URI:
 `gs://a/b/c.[extension]` stored in a gcs_destination bucket with name
 "my_bucket" will have an output URI:
 `gs://my_bucket/a_b_c_[trg]_translations.[ext]`, where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.


 If the document was directly provided through the request, then the
 output document will have the format:
 `gs://my_bucket/translated_document_[trg]_translations.[ext]`, where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.

 If a glossary was provided, then the output URI for the glossary
 translation will be equal to the default output URI but have
 `glossary_translations` instead of `translations`. For the previous
 example, its glossary URI would be:
 `gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext]`.

 Thus the max number of output files will be 2 (Translated document,
 Glossary translated document).

 Callers should expect no partial outputs. If there is any error during
 document translation, no output will be stored in the Cloud Storage
 bucket.
        .google.cloud.translation.v3.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getGcsDestination in interface DocumentOutputConfigOrBuilder
        Returns:
        The gcsDestination.

      • setGcsDestination

        public DocumentOutputConfig.Builder setGcsDestination​(GcsDestination value)
         Optional. Google Cloud Storage destination for the translation output,
 e.g., `gs://my_bucket/my_directory/`.

 The destination directory provided does not have to be empty, but the
 bucket must exist. If a file with the same name as the output file
 already exists in the destination an error will be returned.

 For a DocumentInputConfig.contents provided document, the output file
 will have the name "output_[trg]_translations.[ext]", where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.


 For a DocumentInputConfig.gcs_uri provided document, the output file will
 have a name according to its URI. For example: an input file with URI:
 `gs://a/b/c.[extension]` stored in a gcs_destination bucket with name
 "my_bucket" will have an output URI:
 `gs://my_bucket/a_b_c_[trg]_translations.[ext]`, where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.


 If the document was directly provided through the request, then the
 output document will have the format:
 `gs://my_bucket/translated_document_[trg]_translations.[ext]`, where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.

 If a glossary was provided, then the output URI for the glossary
 translation will be equal to the default output URI but have
 `glossary_translations` instead of `translations`. For the previous
 example, its glossary URI would be:
 `gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext]`.

 Thus the max number of output files will be 2 (Translated document,
 Glossary translated document).

 Callers should expect no partial outputs. If there is any error during
 document translation, no output will be stored in the Cloud Storage
 bucket.
        .google.cloud.translation.v3.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];

      • setGcsDestination

        public DocumentOutputConfig.Builder setGcsDestination​(GcsDestination.Builder builderForValue)
         Optional. Google Cloud Storage destination for the translation output,
 e.g., `gs://my_bucket/my_directory/`.

 The destination directory provided does not have to be empty, but the
 bucket must exist. If a file with the same name as the output file
 already exists in the destination an error will be returned.

 For a DocumentInputConfig.contents provided document, the output file
 will have the name "output_[trg]_translations.[ext]", where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.


 For a DocumentInputConfig.gcs_uri provided document, the output file will
 have a name according to its URI. For example: an input file with URI:
 `gs://a/b/c.[extension]` stored in a gcs_destination bucket with name
 "my_bucket" will have an output URI:
 `gs://my_bucket/a_b_c_[trg]_translations.[ext]`, where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.


 If the document was directly provided through the request, then the
 output document will have the format:
 `gs://my_bucket/translated_document_[trg]_translations.[ext]`, where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.

 If a glossary was provided, then the output URI for the glossary
 translation will be equal to the default output URI but have
 `glossary_translations` instead of `translations`. For the previous
 example, its glossary URI would be:
 `gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext]`.

 Thus the max number of output files will be 2 (Translated document,
 Glossary translated document).

 Callers should expect no partial outputs. If there is any error during
 document translation, no output will be stored in the Cloud Storage
 bucket.
        .google.cloud.translation.v3.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];

      • mergeGcsDestination

        public DocumentOutputConfig.Builder mergeGcsDestination​(GcsDestination value)
         Optional. Google Cloud Storage destination for the translation output,
 e.g., `gs://my_bucket/my_directory/`.

 The destination directory provided does not have to be empty, but the
 bucket must exist. If a file with the same name as the output file
 already exists in the destination an error will be returned.

 For a DocumentInputConfig.contents provided document, the output file
 will have the name "output_[trg]_translations.[ext]", where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.


 For a DocumentInputConfig.gcs_uri provided document, the output file will
 have a name according to its URI. For example: an input file with URI:
 `gs://a/b/c.[extension]` stored in a gcs_destination bucket with name
 "my_bucket" will have an output URI:
 `gs://my_bucket/a_b_c_[trg]_translations.[ext]`, where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.


 If the document was directly provided through the request, then the
 output document will have the format:
 `gs://my_bucket/translated_document_[trg]_translations.[ext]`, where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.

 If a glossary was provided, then the output URI for the glossary
 translation will be equal to the default output URI but have
 `glossary_translations` instead of `translations`. For the previous
 example, its glossary URI would be:
 `gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext]`.

 Thus the max number of output files will be 2 (Translated document,
 Glossary translated document).

 Callers should expect no partial outputs. If there is any error during
 document translation, no output will be stored in the Cloud Storage
 bucket.
        .google.cloud.translation.v3.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];

      • clearGcsDestination

        public DocumentOutputConfig.Builder clearGcsDestination()
         Optional. Google Cloud Storage destination for the translation output,
 e.g., `gs://my_bucket/my_directory/`.

 The destination directory provided does not have to be empty, but the
 bucket must exist. If a file with the same name as the output file
 already exists in the destination an error will be returned.

 For a DocumentInputConfig.contents provided document, the output file
 will have the name "output_[trg]_translations.[ext]", where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.


 For a DocumentInputConfig.gcs_uri provided document, the output file will
 have a name according to its URI. For example: an input file with URI:
 `gs://a/b/c.[extension]` stored in a gcs_destination bucket with name
 "my_bucket" will have an output URI:
 `gs://my_bucket/a_b_c_[trg]_translations.[ext]`, where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.


 If the document was directly provided through the request, then the
 output document will have the format:
 `gs://my_bucket/translated_document_[trg]_translations.[ext]`, where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.

 If a glossary was provided, then the output URI for the glossary
 translation will be equal to the default output URI but have
 `glossary_translations` instead of `translations`. For the previous
 example, its glossary URI would be:
 `gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext]`.

 Thus the max number of output files will be 2 (Translated document,
 Glossary translated document).

 Callers should expect no partial outputs. If there is any error during
 document translation, no output will be stored in the Cloud Storage
 bucket.
        .google.cloud.translation.v3.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];

      • getGcsDestinationBuilder

        public GcsDestination.Builder getGcsDestinationBuilder()
         Optional. Google Cloud Storage destination for the translation output,
 e.g., `gs://my_bucket/my_directory/`.

 The destination directory provided does not have to be empty, but the
 bucket must exist. If a file with the same name as the output file
 already exists in the destination an error will be returned.

 For a DocumentInputConfig.contents provided document, the output file
 will have the name "output_[trg]_translations.[ext]", where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.


 For a DocumentInputConfig.gcs_uri provided document, the output file will
 have a name according to its URI. For example: an input file with URI:
 `gs://a/b/c.[extension]` stored in a gcs_destination bucket with name
 "my_bucket" will have an output URI:
 `gs://my_bucket/a_b_c_[trg]_translations.[ext]`, where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.


 If the document was directly provided through the request, then the
 output document will have the format:
 `gs://my_bucket/translated_document_[trg]_translations.[ext]`, where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.

 If a glossary was provided, then the output URI for the glossary
 translation will be equal to the default output URI but have
 `glossary_translations` instead of `translations`. For the previous
 example, its glossary URI would be:
 `gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext]`.

 Thus the max number of output files will be 2 (Translated document,
 Glossary translated document).

 Callers should expect no partial outputs. If there is any error during
 document translation, no output will be stored in the Cloud Storage
 bucket.
        .google.cloud.translation.v3.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];

      • getGcsDestinationOrBuilder

        public GcsDestinationOrBuilder getGcsDestinationOrBuilder()
         Optional. Google Cloud Storage destination for the translation output,
 e.g., `gs://my_bucket/my_directory/`.

 The destination directory provided does not have to be empty, but the
 bucket must exist. If a file with the same name as the output file
 already exists in the destination an error will be returned.

 For a DocumentInputConfig.contents provided document, the output file
 will have the name "output_[trg]_translations.[ext]", where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.


 For a DocumentInputConfig.gcs_uri provided document, the output file will
 have a name according to its URI. For example: an input file with URI:
 `gs://a/b/c.[extension]` stored in a gcs_destination bucket with name
 "my_bucket" will have an output URI:
 `gs://my_bucket/a_b_c_[trg]_translations.[ext]`, where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.


 If the document was directly provided through the request, then the
 output document will have the format:
 `gs://my_bucket/translated_document_[trg]_translations.[ext]`, where
 - [trg] corresponds to the translated file's language code,
 - [ext] corresponds to the translated file's extension according to its
 mime type.

 If a glossary was provided, then the output URI for the glossary
 translation will be equal to the default output URI but have
 `glossary_translations` instead of `translations`. For the previous
 example, its glossary URI would be:
 `gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext]`.

 Thus the max number of output files will be 2 (Translated document,
 Glossary translated document).

 Callers should expect no partial outputs. If there is any error during
 document translation, no output will be stored in the Cloud Storage
 bucket.
        .google.cloud.translation.v3.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getGcsDestinationOrBuilder in interface DocumentOutputConfigOrBuilder

      • getMimeType

        public String getMimeType()
         Optional. Specifies the translated document's mime_type.
 If not specified, the translated file's mime type will be the same as the
 input file's mime type.
 Currently only support the output mime type to be the same as input mime
 type.
 - application/pdf
 - application/vnd.openxmlformats-officedocument.wordprocessingml.document
 - application/vnd.openxmlformats-officedocument.presentationml.presentation
 - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
        string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMimeType in interface DocumentOutputConfigOrBuilder
        Returns:
        The mimeType.

      • getMimeTypeBytes

        public com.google.protobuf.ByteString getMimeTypeBytes()
         Optional. Specifies the translated document's mime_type.
 If not specified, the translated file's mime type will be the same as the
 input file's mime type.
 Currently only support the output mime type to be the same as input mime
 type.
 - application/pdf
 - application/vnd.openxmlformats-officedocument.wordprocessingml.document
 - application/vnd.openxmlformats-officedocument.presentationml.presentation
 - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
        string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMimeTypeBytes in interface DocumentOutputConfigOrBuilder
        Returns:
        The bytes for mimeType.

      • setMimeType

        public DocumentOutputConfig.Builder setMimeType​(String value)
         Optional. Specifies the translated document's mime_type.
 If not specified, the translated file's mime type will be the same as the
 input file's mime type.
 Currently only support the output mime type to be the same as input mime
 type.
 - application/pdf
 - application/vnd.openxmlformats-officedocument.wordprocessingml.document
 - application/vnd.openxmlformats-officedocument.presentationml.presentation
 - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
        string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The mimeType to set.
        Returns:
        This builder for chaining.

      • clearMimeType

        public DocumentOutputConfig.Builder clearMimeType()
         Optional. Specifies the translated document's mime_type.
 If not specified, the translated file's mime type will be the same as the
 input file's mime type.
 Currently only support the output mime type to be the same as input mime
 type.
 - application/pdf
 - application/vnd.openxmlformats-officedocument.wordprocessingml.document
 - application/vnd.openxmlformats-officedocument.presentationml.presentation
 - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
        string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setMimeTypeBytes

        public DocumentOutputConfig.Builder setMimeTypeBytes​(com.google.protobuf.ByteString value)
         Optional. Specifies the translated document's mime_type.
 If not specified, the translated file's mime type will be the same as the
 input file's mime type.
 Currently only support the output mime type to be the same as input mime
 type.
 - application/pdf
 - application/vnd.openxmlformats-officedocument.wordprocessingml.document
 - application/vnd.openxmlformats-officedocument.presentationml.presentation
 - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
        string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for mimeType to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final DocumentOutputConfig.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<DocumentOutputConfig.Builder>

      • mergeUnknownFields

        public final DocumentOutputConfig.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<DocumentOutputConfig.Builder>