Package com.google.cloud.contentwarehouse.v1

Class GcsIngestPipeline.Builder

  • All Implemented Interfaces:
    GcsIngestPipelineOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    GcsIngestPipeline
    public static final class GcsIngestPipeline.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<GcsIngestPipeline.Builder>
implements GcsIngestPipelineOrBuilder
     The configuration of the Cloud Storage Ingestion pipeline.
    Protobuf type google.cloud.contentwarehouse.v1.GcsIngestPipeline

    • Method Detail

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

      • clear

        public GcsIngestPipeline.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<GcsIngestPipeline.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GcsIngestPipeline.Builder>

      • getDefaultInstanceForType

        public GcsIngestPipeline getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • clone

        public GcsIngestPipeline.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<GcsIngestPipeline.Builder>

      • setField

        public GcsIngestPipeline.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<GcsIngestPipeline.Builder>

      • clearField

        public GcsIngestPipeline.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GcsIngestPipeline.Builder>

      • clearOneof

        public GcsIngestPipeline.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GcsIngestPipeline.Builder>

      • setRepeatedField

        public GcsIngestPipeline.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GcsIngestPipeline.Builder>

      • addRepeatedField

        public GcsIngestPipeline.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GcsIngestPipeline.Builder>

      • mergeFrom

        public GcsIngestPipeline.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GcsIngestPipeline.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GcsIngestPipeline.Builder>

      • mergeFrom

        public GcsIngestPipeline.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GcsIngestPipeline.Builder>
        Throws:
        IOException

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

      • setInputPath

        public GcsIngestPipeline.Builder setInputPath​(String value)
         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;
        Parameters:
        value - The inputPath to set.
        Returns:
        This builder for chaining.

      • clearInputPath

        public GcsIngestPipeline.Builder clearInputPath()
         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:
        This builder for chaining.

      • setInputPathBytes

        public GcsIngestPipeline.Builder setInputPathBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for inputPath to set.
        Returns:
        This builder for chaining.

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

      • setSchemaName

        public GcsIngestPipeline.Builder setSchemaName​(String value)
         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;
        Parameters:
        value - The schemaName to set.
        Returns:
        This builder for chaining.

      • clearSchemaName

        public GcsIngestPipeline.Builder clearSchemaName()
         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:
        This builder for chaining.

      • setSchemaNameBytes

        public GcsIngestPipeline.Builder setSchemaNameBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for schemaName to set.
        Returns:
        This builder for chaining.

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

      • setProcessorType

        public GcsIngestPipeline.Builder setProcessorType​(String value)
         The Doc AI processor type name. Only used when the format of ingested
 files is Doc AI Document proto format.
        string processor_type = 3;
        Parameters:
        value - The processorType to set.
        Returns:
        This builder for chaining.

      • clearProcessorType

        public GcsIngestPipeline.Builder clearProcessorType()
         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:
        This builder for chaining.

      • setProcessorTypeBytes

        public GcsIngestPipeline.Builder setProcessorTypeBytes​(com.google.protobuf.ByteString value)
         The Doc AI processor type name. Only used when the format of ingested
 files is Doc AI Document proto format.
        string processor_type = 3;
        Parameters:
        value - The bytes for processorType to set.
        Returns:
        This builder for chaining.

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

      • setSkipIngestedDocuments

        public GcsIngestPipeline.Builder setSkipIngestedDocuments​(boolean value)
         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;
        Parameters:
        value - The skipIngestedDocuments to set.
        Returns:
        This builder for chaining.

      • clearSkipIngestedDocuments

        public GcsIngestPipeline.Builder clearSkipIngestedDocuments()
         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:
        This builder for chaining.

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

      • setPipelineConfig

        public GcsIngestPipeline.Builder setPipelineConfig​(IngestPipelineConfig value)
         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];

      • setPipelineConfig

        public GcsIngestPipeline.Builder setPipelineConfig​(IngestPipelineConfig.Builder builderForValue)
         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];

      • mergePipelineConfig

        public GcsIngestPipeline.Builder mergePipelineConfig​(IngestPipelineConfig value)
         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];

      • clearPipelineConfig

        public GcsIngestPipeline.Builder clearPipelineConfig()
         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];

      • getPipelineConfigBuilder

        public IngestPipelineConfig.Builder getPipelineConfigBuilder()
         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];

      • 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

      • setUnknownFields

        public final GcsIngestPipeline.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GcsIngestPipeline.Builder>

      • mergeUnknownFields

        public final GcsIngestPipeline.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GcsIngestPipeline.Builder>