Package com.google.cloud.contentwarehouse.v1

Class GcsIngestPipeline

  • All Implemented Interfaces:
    GcsIngestPipelineOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class GcsIngestPipeline
extends com.google.protobuf.GeneratedMessageV3
implements GcsIngestPipelineOrBuilder
     The configuration of the Cloud Storage Ingestion pipeline.
    Protobuf type google.cloud.contentwarehouse.v1.GcsIngestPipeline
    See Also:
    Serialized Form

    • Field Detail

      • INPUT_PATH_FIELD_NUMBER

        public static final int INPUT_PATH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SCHEMA_NAME_FIELD_NUMBER

        public static final int SCHEMA_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROCESSOR_TYPE_FIELD_NUMBER

        public static final int PROCESSOR_TYPE_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 GcsIngestPipelineOrBuilder
        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 GcsIngestPipelineOrBuilder
        Returns:
        The bytes for inputPath.

      • getSchemaName

        public String getSchemaName()
         The Document Warehouse schema resource name. All documents processed by
 this pipeline will use this schema.
 Format:
 projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
        string schema_name = 2;
        Specified by:
        getSchemaName in interface GcsIngestPipelineOrBuilder
        Returns:
        The schemaName.

      • getSchemaNameBytes

        public com.google.protobuf.ByteString getSchemaNameBytes()
         The Document Warehouse schema resource name. All documents processed by
 this pipeline will use this schema.
 Format:
 projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
        string schema_name = 2;
        Specified by:
        getSchemaNameBytes in interface GcsIngestPipelineOrBuilder
        Returns:
        The bytes for schemaName.

      • getProcessorType

        public String getProcessorType()
         The Doc AI processor type name. Only used when the format of ingested
 files is Doc AI Document proto format.
        string processor_type = 3;
        Specified by:
        getProcessorType in interface GcsIngestPipelineOrBuilder
        Returns:
        The processorType.

      • getProcessorTypeBytes

        public com.google.protobuf.ByteString getProcessorTypeBytes()
         The Doc AI processor type name. Only used when the format of ingested
 files is Doc AI Document proto format.
        string processor_type = 3;
        Specified by:
        getProcessorTypeBytes in interface GcsIngestPipelineOrBuilder
        Returns:
        The bytes for processorType.

      • 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 = 4;
        Specified by:
        getSkipIngestedDocuments in interface GcsIngestPipelineOrBuilder
        Returns:
        The skipIngestedDocuments.

      • hasPipelineConfig

        public boolean hasPipelineConfig()
         Optional. The config for the Cloud Storage Ingestion 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasPipelineConfig in interface GcsIngestPipelineOrBuilder
        Returns:
        Whether the pipelineConfig field is set.

      • getPipelineConfig

        public IngestPipelineConfig getPipelineConfig()
         Optional. The config for the Cloud Storage Ingestion 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPipelineConfig in interface GcsIngestPipelineOrBuilder
        Returns:
        The pipelineConfig.

      • getPipelineConfigOrBuilder

        public IngestPipelineConfigOrBuilder getPipelineConfigOrBuilder()
         Optional. The config for the Cloud Storage Ingestion 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPipelineConfigOrBuilder in interface GcsIngestPipelineOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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