Package com.google.cloud.contentwarehouse.v1

Class ExportToCdwPipeline

  • All Implemented Interfaces:
    ExportToCdwPipelineOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ExportToCdwPipeline
extends com.google.protobuf.GeneratedMessageV3
implements ExportToCdwPipelineOrBuilder
     The configuration of exporting documents from the Document Warehouse to CDW
 pipeline.
    Protobuf type google.cloud.contentwarehouse.v1.ExportToCdwPipeline
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ExportToCdwPipeline.Builder
      The configuration of exporting documents from the Document Warehouse to CDW pipeline.

      • 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 Detail

      • EXPORT_FOLDER_PATH_FIELD_NUMBER

        public static final int EXPORT_FOLDER_PATH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOC_AI_DATASET_FIELD_NUMBER

        public static final int DOC_AI_DATASET_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRAINING_SPLIT_RATIO_FIELD_NUMBER

        public static final int TRAINING_SPLIT_RATIO_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

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

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

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

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

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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