Interface BatchProcessRequestOrBuilder (2.12.0)

Version 2.12.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public interface BatchProcessRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDocumentOutputConfig()

public abstract DocumentOutputConfig getDocumentOutputConfig()

The overall output config for batch process.

.google.cloud.documentai.v1beta3.DocumentOutputConfig document_output_config = 6;

Returns

Type	Description
DocumentOutputConfig	The documentOutputConfig.

getDocumentOutputConfigOrBuilder()

public abstract DocumentOutputConfigOrBuilder getDocumentOutputConfigOrBuilder()

The overall output config for batch process.

.google.cloud.documentai.v1beta3.DocumentOutputConfig document_output_config = 6;

Returns

Type	Description
DocumentOutputConfigOrBuilder

getInputConfigs(int index)

public abstract BatchProcessRequest.BatchInputConfig getInputConfigs(int index)

The input config for each single document in the batch process.

repeated .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig input_configs = 2 [deprecated = true];

Parameter

Name	Description
index	int

Returns

Type	Description
BatchProcessRequest.BatchInputConfig

getInputConfigsCount()

public abstract int getInputConfigsCount()

The input config for each single document in the batch process.

repeated .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig input_configs = 2 [deprecated = true];

Returns

Type	Description
int

getInputConfigsList()

public abstract List<BatchProcessRequest.BatchInputConfig> getInputConfigsList()

The input config for each single document in the batch process.

repeated .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig input_configs = 2 [deprecated = true];

Returns

Type	Description
List<BatchInputConfig>

getInputConfigsOrBuilder(int index)

public abstract BatchProcessRequest.BatchInputConfigOrBuilder getInputConfigsOrBuilder(int index)

The input config for each single document in the batch process.

repeated .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig input_configs = 2 [deprecated = true];

Parameter

Name	Description
index	int

Returns

Type	Description
BatchProcessRequest.BatchInputConfigOrBuilder

getInputConfigsOrBuilderList()

public abstract List<? extends BatchProcessRequest.BatchInputConfigOrBuilder> getInputConfigsOrBuilderList()

The input config for each single document in the batch process.

repeated .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig input_configs = 2 [deprecated = true];

Returns

Type	Description
List<? extends com.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfigOrBuilder>

getInputDocuments()

public abstract BatchDocumentsInputConfig getInputDocuments()

The input documents for batch process.

.google.cloud.documentai.v1beta3.BatchDocumentsInputConfig input_documents = 5;

Returns

Type	Description
BatchDocumentsInputConfig	The inputDocuments.

getInputDocumentsOrBuilder()

public abstract BatchDocumentsInputConfigOrBuilder getInputDocumentsOrBuilder()

The input documents for batch process.

.google.cloud.documentai.v1beta3.BatchDocumentsInputConfig input_documents = 5;

Returns

Type	Description
BatchDocumentsInputConfigOrBuilder

getName()

public abstract String getName()

Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
ByteString	The bytes for name.

getOutputConfig() (deprecated)

public abstract BatchProcessRequest.BatchOutputConfig getOutputConfig()

Deprecated. google.cloud.documentai.v1beta3.BatchProcessRequest.output_config is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=456

The overall output config for batch process.

.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig output_config = 3 [deprecated = true];

Returns

Type	Description
BatchProcessRequest.BatchOutputConfig	The outputConfig.

getOutputConfigOrBuilder()

public abstract BatchProcessRequest.BatchOutputConfigOrBuilder getOutputConfigOrBuilder()

The overall output config for batch process.

.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig output_config = 3 [deprecated = true];

Returns

Type	Description
BatchProcessRequest.BatchOutputConfigOrBuilder

getProcessOptions()

public abstract ProcessOptions getProcessOptions()

Inference-time options for the process API

.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;

Returns

Type	Description
ProcessOptions	The processOptions.

getProcessOptionsOrBuilder()

public abstract ProcessOptionsOrBuilder getProcessOptionsOrBuilder()

Inference-time options for the process API

.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;

Returns

Type	Description
ProcessOptionsOrBuilder

getSkipHumanReview()

public abstract boolean getSkipHumanReview()

Whether Human Review feature should be skipped for this request. Default to false.

bool skip_human_review = 4;

Returns

Type	Description
boolean	The skipHumanReview.

hasDocumentOutputConfig()

public abstract boolean hasDocumentOutputConfig()

The overall output config for batch process.

.google.cloud.documentai.v1beta3.DocumentOutputConfig document_output_config = 6;

Returns

Type	Description
boolean	Whether the documentOutputConfig field is set.

hasInputDocuments()

public abstract boolean hasInputDocuments()

The input documents for batch process.

.google.cloud.documentai.v1beta3.BatchDocumentsInputConfig input_documents = 5;

Returns

Type	Description
boolean	Whether the inputDocuments field is set.

hasOutputConfig() (deprecated)

public abstract boolean hasOutputConfig()

Deprecated. google.cloud.documentai.v1beta3.BatchProcessRequest.output_config is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=456

The overall output config for batch process.

.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig output_config = 3 [deprecated = true];

Returns

Type	Description
boolean	Whether the outputConfig field is set.

hasProcessOptions()

public abstract boolean hasProcessOptions()

Inference-time options for the process API

.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;

Returns

Type	Description
boolean	Whether the processOptions field is set.