Package com.google.cloud.contentwarehouse.v1

Class ProcessWithDocAiPipeline

  • All Implemented Interfaces:
    ProcessWithDocAiPipelineOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ProcessWithDocAiPipeline
extends com.google.protobuf.GeneratedMessageV3
implements ProcessWithDocAiPipelineOrBuilder
     The configuration of processing documents in Document Warehouse with DocAi
 processors pipeline.
    Protobuf type google.cloud.contentwarehouse.v1.ProcessWithDocAiPipeline
    See Also:
    Serialized Form

    • Field Detail

      • EXPORT_FOLDER_PATH_FIELD_NUMBER

        public static final int EXPORT_FOLDER_PATH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROCESSOR_INFO_FIELD_NUMBER

        public static final int PROCESSOR_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROCESSOR_RESULTS_FOLDER_PATH_FIELD_NUMBER

        public static final int PROCESSOR_RESULTS_FOLDER_PATH_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 ProcessWithDocAiPipelineOrBuilder
        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 ProcessWithDocAiPipelineOrBuilder
        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 ProcessWithDocAiPipelineOrBuilder
        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 ProcessWithDocAiPipelineOrBuilder
        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 ProcessWithDocAiPipelineOrBuilder
        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 ProcessWithDocAiPipelineOrBuilder
        Returns:
        The bytes for exportFolderPath.

      • hasProcessorInfo

        public boolean hasProcessorInfo()
         The CDW processor information.
        .google.cloud.contentwarehouse.v1.ProcessorInfo processor_info = 3;
        Specified by:
        hasProcessorInfo in interface ProcessWithDocAiPipelineOrBuilder
        Returns:
        Whether the processorInfo field is set.

      • getProcessorResultsFolderPath

        public String getProcessorResultsFolderPath()
         The Cloud Storage folder path used to store the raw results from
 processors.
 Format: `gs://<bucket-name>/<folder-name>`.
        string processor_results_folder_path = 4;
        Specified by:
        getProcessorResultsFolderPath in interface ProcessWithDocAiPipelineOrBuilder
        Returns:
        The processorResultsFolderPath.

      • getProcessorResultsFolderPathBytes

        public com.google.protobuf.ByteString getProcessorResultsFolderPathBytes()
         The Cloud Storage folder path used to store the raw results from
 processors.
 Format: `gs://<bucket-name>/<folder-name>`.
        string processor_results_folder_path = 4;
        Specified by:
        getProcessorResultsFolderPathBytes in interface ProcessWithDocAiPipelineOrBuilder
        Returns:
        The bytes for processorResultsFolderPath.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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