Package com.google.cloud.contentwarehouse.v1

Class ExportToCdwPipeline.Builder

  • All Implemented Interfaces:
    ExportToCdwPipelineOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ExportToCdwPipeline
    public static final class ExportToCdwPipeline.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ExportToCdwPipeline.Builder>
implements ExportToCdwPipelineOrBuilder
     The configuration of exporting documents from the Document Warehouse to CDW
 pipeline.
    Protobuf type google.cloud.contentwarehouse.v1.ExportToCdwPipeline

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

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

        public ExportToCdwPipeline.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportToCdwPipeline.Builder>

      • isInitialized

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

      • mergeFrom

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

      • getDocumentsList

        public com.google.protobuf.ProtocolStringList getDocumentsList()
         The list of all the resource names of the documents to be processed.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string documents = 1;
        Specified by:
        getDocumentsList in interface ExportToCdwPipelineOrBuilder
        Returns:
        A list containing the documents.

      • getDocumentsCount

        public int getDocumentsCount()
         The list of all the resource names of the documents to be processed.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string documents = 1;
        Specified by:
        getDocumentsCount in interface ExportToCdwPipelineOrBuilder
        Returns:
        The count of documents.

      • getDocuments

        public String getDocuments​(int index)
         The list of all the resource names of the documents to be processed.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string documents = 1;
        Specified by:
        getDocuments in interface ExportToCdwPipelineOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The documents at the given index.

      • getDocumentsBytes

        public com.google.protobuf.ByteString getDocumentsBytes​(int index)
         The list of all the resource names of the documents to be processed.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string documents = 1;
        Specified by:
        getDocumentsBytes in interface ExportToCdwPipelineOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the documents at the given index.

      • setDocuments

        public ExportToCdwPipeline.Builder setDocuments​(int index,
                                                String value)
         The list of all the resource names of the documents to be processed.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string documents = 1;
        Parameters:
        index - The index to set the value at.
        value - The documents to set.
        Returns:
        This builder for chaining.

      • addDocuments

        public ExportToCdwPipeline.Builder addDocuments​(String value)
         The list of all the resource names of the documents to be processed.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string documents = 1;
        Parameters:
        value - The documents to add.
        Returns:
        This builder for chaining.

      • addAllDocuments

        public ExportToCdwPipeline.Builder addAllDocuments​(Iterable<String> values)
         The list of all the resource names of the documents to be processed.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string documents = 1;
        Parameters:
        values - The documents to add.
        Returns:
        This builder for chaining.

      • clearDocuments

        public ExportToCdwPipeline.Builder clearDocuments()
         The list of all the resource names of the documents to be processed.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string documents = 1;
        Returns:
        This builder for chaining.

      • addDocumentsBytes

        public ExportToCdwPipeline.Builder addDocumentsBytes​(com.google.protobuf.ByteString value)
         The list of all the resource names of the documents to be processed.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string documents = 1;
        Parameters:
        value - The bytes of the documents to add.
        Returns:
        This builder for chaining.

      • getExportFolderPath

        public String getExportFolderPath()
         The Cloud Storage folder path used to store the exported documents before
 being sent to CDW.
 Format: `gs://<bucket-name>/<folder-name>`.
        string export_folder_path = 2;
        Specified by:
        getExportFolderPath in interface ExportToCdwPipelineOrBuilder
        Returns:
        The exportFolderPath.

      • getExportFolderPathBytes

        public com.google.protobuf.ByteString getExportFolderPathBytes()
         The Cloud Storage folder path used to store the exported documents before
 being sent to CDW.
 Format: `gs://<bucket-name>/<folder-name>`.
        string export_folder_path = 2;
        Specified by:
        getExportFolderPathBytes in interface ExportToCdwPipelineOrBuilder
        Returns:
        The bytes for exportFolderPath.

      • setExportFolderPath

        public ExportToCdwPipeline.Builder setExportFolderPath​(String value)
         The Cloud Storage folder path used to store the exported documents before
 being sent to CDW.
 Format: `gs://<bucket-name>/<folder-name>`.
        string export_folder_path = 2;
        Parameters:
        value - The exportFolderPath to set.
        Returns:
        This builder for chaining.

      • clearExportFolderPath

        public ExportToCdwPipeline.Builder clearExportFolderPath()
         The Cloud Storage folder path used to store the exported documents before
 being sent to CDW.
 Format: `gs://<bucket-name>/<folder-name>`.
        string export_folder_path = 2;
        Returns:
        This builder for chaining.

      • setExportFolderPathBytes

        public ExportToCdwPipeline.Builder setExportFolderPathBytes​(com.google.protobuf.ByteString value)
         The Cloud Storage folder path used to store the exported documents before
 being sent to CDW.
 Format: `gs://<bucket-name>/<folder-name>`.
        string export_folder_path = 2;
        Parameters:
        value - The bytes for exportFolderPath to set.
        Returns:
        This builder for chaining.

      • getDocAiDataset

        public String getDocAiDataset()
         Optional. The CDW dataset resource name. This field is optional. If not
 set, the documents will be exported to Cloud Storage only. Format:
 projects/{project}/locations/{location}/processors/{processor}/dataset
        string doc_ai_dataset = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDocAiDataset in interface ExportToCdwPipelineOrBuilder
        Returns:
        The docAiDataset.

      • getDocAiDatasetBytes

        public com.google.protobuf.ByteString getDocAiDatasetBytes()
         Optional. The CDW dataset resource name. This field is optional. If not
 set, the documents will be exported to Cloud Storage only. Format:
 projects/{project}/locations/{location}/processors/{processor}/dataset
        string doc_ai_dataset = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDocAiDatasetBytes in interface ExportToCdwPipelineOrBuilder
        Returns:
        The bytes for docAiDataset.

      • setDocAiDataset

        public ExportToCdwPipeline.Builder setDocAiDataset​(String value)
         Optional. The CDW dataset resource name. This field is optional. If not
 set, the documents will be exported to Cloud Storage only. Format:
 projects/{project}/locations/{location}/processors/{processor}/dataset
        string doc_ai_dataset = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The docAiDataset to set.
        Returns:
        This builder for chaining.

      • clearDocAiDataset

        public ExportToCdwPipeline.Builder clearDocAiDataset()
         Optional. The CDW dataset resource name. This field is optional. If not
 set, the documents will be exported to Cloud Storage only. Format:
 projects/{project}/locations/{location}/processors/{processor}/dataset
        string doc_ai_dataset = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setDocAiDatasetBytes

        public ExportToCdwPipeline.Builder setDocAiDatasetBytes​(com.google.protobuf.ByteString value)
         Optional. The CDW dataset resource name. This field is optional. If not
 set, the documents will be exported to Cloud Storage only. Format:
 projects/{project}/locations/{location}/processors/{processor}/dataset
        string doc_ai_dataset = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for docAiDataset to set.
        Returns:
        This builder for chaining.

      • getTrainingSplitRatio

        public float getTrainingSplitRatio()
         Ratio of training dataset split. When importing into Document AI Workbench,
 documents will be automatically split into training and test split category
 with the specified ratio. This field is required if doc_ai_dataset is set.
        float training_split_ratio = 4;
        Specified by:
        getTrainingSplitRatio in interface ExportToCdwPipelineOrBuilder
        Returns:
        The trainingSplitRatio.

      • setTrainingSplitRatio

        public ExportToCdwPipeline.Builder setTrainingSplitRatio​(float value)
         Ratio of training dataset split. When importing into Document AI Workbench,
 documents will be automatically split into training and test split category
 with the specified ratio. This field is required if doc_ai_dataset is set.
        float training_split_ratio = 4;
        Parameters:
        value - The trainingSplitRatio to set.
        Returns:
        This builder for chaining.

      • clearTrainingSplitRatio

        public ExportToCdwPipeline.Builder clearTrainingSplitRatio()
         Ratio of training dataset split. When importing into Document AI Workbench,
 documents will be automatically split into training and test split category
 with the specified ratio. This field is required if doc_ai_dataset is set.
        float training_split_ratio = 4;
        Returns:
        This builder for chaining.

      • setUnknownFields

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

      • mergeUnknownFields

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