Interface GcsIngestPipelineOrBuilder (0.47.0) 

public interface GcsIngestPipelineOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getInputPath()

public abstract 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
Type Description
String

The inputPath.

getInputPathBytes()

public abstract 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
Type Description
ByteString

The bytes for inputPath.

getPipelineConfig()

public abstract 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
Type Description
IngestPipelineConfig

The pipelineConfig.

getPipelineConfigOrBuilder()

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

Returns
Type Description
IngestPipelineConfigOrBuilder

getProcessorType()

public abstract 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
Type Description
String

The processorType.

getProcessorTypeBytes()

public abstract 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
Type Description
ByteString

The bytes for processorType.

getSchemaName()

public abstract 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
Type Description
String

The schemaName.

getSchemaNameBytes()

public abstract 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
Type Description
ByteString

The bytes for schemaName.

getSkipIngestedDocuments()

public abstract 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
Type Description
boolean

The skipIngestedDocuments.

hasPipelineConfig()

public abstract 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
Type Description
boolean

Whether the pipelineConfig field is set.