Package com.google.cloud.contentwarehouse.v1

Class GcsIngestWithDocAiProcessorsPipeline

    • Field Detail

      • INPUT_PATH_FIELD_NUMBER

        public static final int INPUT_PATH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SPLIT_CLASSIFY_PROCESSOR_INFO_FIELD_NUMBER

        public static final int SPLIT_CLASSIFY_PROCESSOR_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXTRACT_PROCESSOR_INFOS_FIELD_NUMBER

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

      • SKIP_INGESTED_DOCUMENTS_FIELD_NUMBER

        public static final int SKIP_INGESTED_DOCUMENTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PIPELINE_CONFIG_FIELD_NUMBER

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

      • getInputPath

        public String getInputPath()
         The input Cloud Storage folder. All files under this folder will be
 imported to Document Warehouse.
 Format: `gs://<bucket-name>/<folder-name>`.
        string input_path = 1;
        Specified by:
        getInputPath in interface GcsIngestWithDocAiProcessorsPipelineOrBuilder
        Returns:
        The inputPath.

      • getInputPathBytes

        public com.google.protobuf.ByteString getInputPathBytes()
         The input Cloud Storage folder. All files under this folder will be
 imported to Document Warehouse.
 Format: `gs://<bucket-name>/<folder-name>`.
        string input_path = 1;
        Specified by:
        getInputPathBytes in interface GcsIngestWithDocAiProcessorsPipelineOrBuilder
        Returns:
        The bytes for inputPath.

      • hasSplitClassifyProcessorInfo

        public boolean hasSplitClassifyProcessorInfo()
         The split and classify processor information.
 The split and classify result will be used to find a matched extract
 processor.
        .google.cloud.contentwarehouse.v1.ProcessorInfo split_classify_processor_info = 2;
        Specified by:
        hasSplitClassifyProcessorInfo in interface GcsIngestWithDocAiProcessorsPipelineOrBuilder
        Returns:
        Whether the splitClassifyProcessorInfo field is set.

      • getSplitClassifyProcessorInfo

        public ProcessorInfo getSplitClassifyProcessorInfo()
         The split and classify processor information.
 The split and classify result will be used to find a matched extract
 processor.
        .google.cloud.contentwarehouse.v1.ProcessorInfo split_classify_processor_info = 2;
        Specified by:
        getSplitClassifyProcessorInfo in interface GcsIngestWithDocAiProcessorsPipelineOrBuilder
        Returns:
        The splitClassifyProcessorInfo.

      • getExtractProcessorInfosList

        public List<ProcessorInfo> getExtractProcessorInfosList()
         The extract processors information.
 One matched extract processor will be used to process documents based on
 the classify processor result. If no classify processor is specified, the
 first extract processor will be used.
        repeated .google.cloud.contentwarehouse.v1.ProcessorInfo extract_processor_infos = 3;
        Specified by:
        getExtractProcessorInfosList in interface GcsIngestWithDocAiProcessorsPipelineOrBuilder

      • getExtractProcessorInfosOrBuilderList

        public List<? extends ProcessorInfoOrBuilder> getExtractProcessorInfosOrBuilderList()
         The extract processors information.
 One matched extract processor will be used to process documents based on
 the classify processor result. If no classify processor is specified, the
 first extract processor will be used.
        repeated .google.cloud.contentwarehouse.v1.ProcessorInfo extract_processor_infos = 3;
        Specified by:
        getExtractProcessorInfosOrBuilderList in interface GcsIngestWithDocAiProcessorsPipelineOrBuilder

      • getExtractProcessorInfosCount

        public int getExtractProcessorInfosCount()
         The extract processors information.
 One matched extract processor will be used to process documents based on
 the classify processor result. If no classify processor is specified, the
 first extract processor will be used.
        repeated .google.cloud.contentwarehouse.v1.ProcessorInfo extract_processor_infos = 3;
        Specified by:
        getExtractProcessorInfosCount in interface GcsIngestWithDocAiProcessorsPipelineOrBuilder

      • getExtractProcessorInfos

        public ProcessorInfo getExtractProcessorInfos​(int index)
         The extract processors information.
 One matched extract processor will be used to process documents based on
 the classify processor result. If no classify processor is specified, the
 first extract processor will be used.
        repeated .google.cloud.contentwarehouse.v1.ProcessorInfo extract_processor_infos = 3;
        Specified by:
        getExtractProcessorInfos in interface GcsIngestWithDocAiProcessorsPipelineOrBuilder

      • getExtractProcessorInfosOrBuilder

        public ProcessorInfoOrBuilder getExtractProcessorInfosOrBuilder​(int index)
         The extract processors information.
 One matched extract processor will be used to process documents based on
 the classify processor result. If no classify processor is specified, the
 first extract processor will be used.
        repeated .google.cloud.contentwarehouse.v1.ProcessorInfo extract_processor_infos = 3;
        Specified by:
        getExtractProcessorInfosOrBuilder in interface GcsIngestWithDocAiProcessorsPipelineOrBuilder

      • 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 GcsIngestWithDocAiProcessorsPipelineOrBuilder
        Returns:
        The bytes for processorResultsFolderPath.

      • getSkipIngestedDocuments

        public boolean getSkipIngestedDocuments()
         The flag whether to skip ingested documents.
 If it is set to true, documents in Cloud Storage contains key "status" with
 value "status=ingested" in custom metadata will be skipped to ingest.
        bool skip_ingested_documents = 5;
        Specified by:
        getSkipIngestedDocuments in interface GcsIngestWithDocAiProcessorsPipelineOrBuilder
        Returns:
        The skipIngestedDocuments.

      • hasPipelineConfig

        public boolean hasPipelineConfig()
         Optional. The config for the Cloud Storage Ingestion with DocAI Processors
 pipeline. It provides additional customization options to run the pipeline
 and can be skipped if it is not applicable.
        .google.cloud.contentwarehouse.v1.IngestPipelineConfig pipeline_config = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasPipelineConfig in interface GcsIngestWithDocAiProcessorsPipelineOrBuilder
        Returns:
        Whether the pipelineConfig field is set.

      • getPipelineConfig

        public IngestPipelineConfig getPipelineConfig()
         Optional. The config for the Cloud Storage Ingestion with DocAI Processors
 pipeline. It provides additional customization options to run the pipeline
 and can be skipped if it is not applicable.
        .google.cloud.contentwarehouse.v1.IngestPipelineConfig pipeline_config = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPipelineConfig in interface GcsIngestWithDocAiProcessorsPipelineOrBuilder
        Returns:
        The pipelineConfig.

      • getPipelineConfigOrBuilder

        public IngestPipelineConfigOrBuilder getPipelineConfigOrBuilder()
         Optional. The config for the Cloud Storage Ingestion with DocAI Processors
 pipeline. It provides additional customization options to run the pipeline
 and can be skipped if it is not applicable.
        .google.cloud.contentwarehouse.v1.IngestPipelineConfig pipeline_config = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPipelineConfigOrBuilder in interface GcsIngestWithDocAiProcessorsPipelineOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • newBuilderForType

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

      • getParserForType

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