Package com.google.cloud.contentwarehouse.v1

Interface GcsIngestPipelineOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    GcsIngestPipeline, GcsIngestPipeline.Builder
    public interface GcsIngestPipelineOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getInputPath

        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;
        Returns:
        The inputPath.

      • getInputPathBytes

        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;
        Returns:
        The bytes for inputPath.

      • getSchemaName

        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;
        Returns:
        The schemaName.

      • getSchemaNameBytes

        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;
        Returns:
        The bytes for schemaName.

      • getProcessorType

        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;
        Returns:
        The processorType.

      • getProcessorTypeBytes

        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;
        Returns:
        The bytes for processorType.

      • getSkipIngestedDocuments

        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;
        Returns:
        The skipIngestedDocuments.

      • hasPipelineConfig

        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];
        Returns:
        Whether the pipelineConfig field is set.

      • getPipelineConfig

        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];
        Returns:
        The pipelineConfig.

      • getPipelineConfigOrBuilder

        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];