com.google.cloud.documentai.v1beta3

Interface BatchProcessRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

BatchProcessRequest, BatchProcessRequest.Builder

public interface BatchProcessRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
DocumentOutputConfig	getDocumentOutputConfig() The output configuration for the [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments] method.
DocumentOutputConfigOrBuilder	getDocumentOutputConfigOrBuilder() The output configuration for the [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments] method.
BatchProcessRequest.BatchInputConfig	getInputConfigs(int index) Deprecated.
int	getInputConfigsCount() Deprecated.
List<BatchProcessRequest.BatchInputConfig>	getInputConfigsList() Deprecated.
BatchProcessRequest.BatchInputConfigOrBuilder	getInputConfigsOrBuilder(int index) Deprecated.
List<? extends BatchProcessRequest.BatchInputConfigOrBuilder>	getInputConfigsOrBuilderList() Deprecated.
BatchDocumentsInputConfig	getInputDocuments() The input documents for the [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments] method.
BatchDocumentsInputConfigOrBuilder	getInputDocumentsOrBuilder() The input documents for the [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments] method.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
BatchProcessRequest.BatchOutputConfig	getOutputConfig() Deprecated. google.cloud.documentai.v1beta3.BatchProcessRequest.output_config is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=580
BatchProcessRequest.BatchOutputConfigOrBuilder	getOutputConfigOrBuilder() Deprecated.
ProcessOptions	getProcessOptions() Inference-time options for the process API .google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
ProcessOptionsOrBuilder	getProcessOptionsOrBuilder() Inference-time options for the process API .google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
boolean	getSkipHumanReview() Whether human review should be skipped for this request.
boolean	hasDocumentOutputConfig() The output configuration for the [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments] method.
boolean	hasInputDocuments() The input documents for the [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments] method.
boolean	hasOutputConfig() Deprecated. google.cloud.documentai.v1beta3.BatchProcessRequest.output_config is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=580
boolean	hasProcessOptions() Inference-time options for the process API .google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Required. The resource name of
 [Processor][google.cloud.documentai.v1beta3.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1beta3.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:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Required. The resource name of
 [Processor][google.cloud.documentai.v1beta3.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1beta3.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:

The bytes for name.

getInputConfigsList

@Deprecated
List<BatchProcessRequest.BatchInputConfig> getInputConfigsList()

Deprecated.

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

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

getInputConfigs

@Deprecated
BatchProcessRequest.BatchInputConfig getInputConfigs(int index)

Deprecated.

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

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

getInputConfigsCount

@Deprecated
int getInputConfigsCount()

Deprecated.

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

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

getInputConfigsOrBuilderList

@Deprecated
List<? extends BatchProcessRequest.BatchInputConfigOrBuilder> getInputConfigsOrBuilderList()

Deprecated.

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

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

getInputConfigsOrBuilder

@Deprecated
BatchProcessRequest.BatchInputConfigOrBuilder getInputConfigsOrBuilder(int index)

Deprecated.

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

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

hasOutputConfig

@Deprecated
boolean hasOutputConfig()

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

 The overall output config for batch process.
 

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

Returns:

Whether the outputConfig field is set.

getOutputConfig

@Deprecated
BatchProcessRequest.BatchOutputConfig getOutputConfig()

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

 The overall output config for batch process.
 

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

Returns:

The outputConfig.

getOutputConfigOrBuilder

@Deprecated
BatchProcessRequest.BatchOutputConfigOrBuilder getOutputConfigOrBuilder()

Deprecated.

 The overall output config for batch process.
 

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

hasInputDocuments

boolean hasInputDocuments()

 The input documents for the
 [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
 method.
 

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

Returns:

Whether the inputDocuments field is set.

getInputDocuments

BatchDocumentsInputConfig getInputDocuments()

 The input documents for the
 [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
 method.
 

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

Returns:

The inputDocuments.

getInputDocumentsOrBuilder

BatchDocumentsInputConfigOrBuilder getInputDocumentsOrBuilder()

 The input documents for the
 [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
 method.
 

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

hasDocumentOutputConfig

boolean hasDocumentOutputConfig()

 The output configuration for the
 [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
 method.
 

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

Returns:

Whether the documentOutputConfig field is set.

getDocumentOutputConfig

DocumentOutputConfig getDocumentOutputConfig()

 The output configuration for the
 [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
 method.
 

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

Returns:

The documentOutputConfig.

getDocumentOutputConfigOrBuilder

DocumentOutputConfigOrBuilder getDocumentOutputConfigOrBuilder()

 The output configuration for the
 [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
 method.
 

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

getSkipHumanReview

boolean getSkipHumanReview()

 Whether human review should be skipped for this request. Default to
 `false`.
 

bool skip_human_review = 4;

Returns:

The skipHumanReview.

hasProcessOptions

boolean hasProcessOptions()

 Inference-time options for the process API
 

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

Returns:

Whether the processOptions field is set.

getProcessOptions

ProcessOptions getProcessOptions()

 Inference-time options for the process API
 

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

Returns:

The processOptions.

getProcessOptionsOrBuilder

ProcessOptionsOrBuilder getProcessOptionsOrBuilder()

 Inference-time options for the process API
 

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

getLabelsCount

int getLabelsCount()

 Optional. The labels with user-defined metadata for the request.

 Label keys and values can be no longer than 63 characters
 (Unicode codepoints) and can only contain lowercase letters, numeric
 characters, underscores, and dashes. International characters are allowed.
 Label values are optional. Label keys must start with a letter.
 

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

containsLabels

boolean containsLabels(String key)

 Optional. The labels with user-defined metadata for the request.

 Label keys and values can be no longer than 63 characters
 (Unicode codepoints) and can only contain lowercase letters, numeric
 characters, underscores, and dashes. International characters are allowed.
 Label values are optional. Label keys must start with a letter.
 

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> getLabelsMap()

 Optional. The labels with user-defined metadata for the request.

 Label keys and values can be no longer than 63 characters
 (Unicode codepoints) and can only contain lowercase letters, numeric
 characters, underscores, and dashes. International characters are allowed.
 Label values are optional. Label keys must start with a letter.
 

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

getLabelsOrDefault

String getLabelsOrDefault(String key,
                          String defaultValue)

 Optional. The labels with user-defined metadata for the request.

 Label keys and values can be no longer than 63 characters
 (Unicode codepoints) and can only contain lowercase letters, numeric
 characters, underscores, and dashes. International characters are allowed.
 Label values are optional. Label keys must start with a letter.
 

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

getLabelsOrThrow

String getLabelsOrThrow(String key)

 Optional. The labels with user-defined metadata for the request.

 Label keys and values can be no longer than 63 characters
 (Unicode codepoints) and can only contain lowercase letters, numeric
 characters, underscores, and dashes. International characters are allowed.
 Label values are optional. Label keys must start with a letter.
 

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];