Interface GcsIngestWithDocAiProcessorsPipelineOrBuilder (0.41.0)

public interface GcsIngestWithDocAiProcessorsPipelineOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getExtractProcessorInfos(int index)

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

Parameter
Name Description
index int
Returns
Type Description
ProcessorInfo

getExtractProcessorInfosCount()

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

Returns
Type Description
int

getExtractProcessorInfosList()

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

Returns
Type Description
List<ProcessorInfo>

getExtractProcessorInfosOrBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
ProcessorInfoOrBuilder

getExtractProcessorInfosOrBuilderList()

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

Returns
Type Description
List<? extends com.google.cloud.contentwarehouse.v1.ProcessorInfoOrBuilder>

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

Returns
Type Description
IngestPipelineConfig

The pipelineConfig.

getPipelineConfigOrBuilder()

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

Returns
Type Description
IngestPipelineConfigOrBuilder

getProcessorResultsFolderPath()

public abstract String getProcessorResultsFolderPath()

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;

Returns
Type Description
String

The processorResultsFolderPath.

getProcessorResultsFolderPathBytes()

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

Returns
Type Description
ByteString

The bytes for processorResultsFolderPath.

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 = 5;

Returns
Type Description
boolean

The skipIngestedDocuments.

getSplitClassifyProcessorInfo()

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

Returns
Type Description
ProcessorInfo

The splitClassifyProcessorInfo.

getSplitClassifyProcessorInfoOrBuilder()

public abstract ProcessorInfoOrBuilder getSplitClassifyProcessorInfoOrBuilder()

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;

Returns
Type Description
ProcessorInfoOrBuilder

hasPipelineConfig()

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

Returns
Type Description
boolean

Whether the pipelineConfig field is set.

hasSplitClassifyProcessorInfo()

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

Returns
Type Description
boolean

Whether the splitClassifyProcessorInfo field is set.