Class BatchProcessRequest.Builder (2.46.0)

Version 2.46.0

• 2.59.0 (latest)
• 2.58.0
• 2.57.0
• 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 static final class BatchProcessRequest.Builder extends GeneratedMessageV3.Builder<BatchProcessRequest.Builder> implements BatchProcessRequestOrBuilder

Request message for BatchProcessDocuments.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BatchProcessRequest.Builder

Implements

BatchProcessRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllInputConfigs(Iterable<? extends BatchProcessRequest.BatchInputConfig> values) (deprecated)

public BatchProcessRequest.Builder addAllInputConfigs(Iterable<? extends BatchProcessRequest.BatchInputConfig> values)

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
values	Iterable<? extends com.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig>

Returns
Type	Description
BatchProcessRequest.Builder

addInputConfigs(BatchProcessRequest.BatchInputConfig value) (deprecated)

public BatchProcessRequest.Builder addInputConfigs(BatchProcessRequest.BatchInputConfig value)

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
value	BatchProcessRequest.BatchInputConfig

Returns
Type	Description
BatchProcessRequest.Builder

addInputConfigs(BatchProcessRequest.BatchInputConfig.Builder builderForValue) (deprecated)

public BatchProcessRequest.Builder addInputConfigs(BatchProcessRequest.BatchInputConfig.Builder builderForValue)

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
builderForValue	BatchProcessRequest.BatchInputConfig.Builder

Returns
Type	Description
BatchProcessRequest.Builder

addInputConfigs(int index, BatchProcessRequest.BatchInputConfig value) (deprecated)

public BatchProcessRequest.Builder addInputConfigs(int index, BatchProcessRequest.BatchInputConfig value)

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

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

Parameters
Name	Description
index	int
value	BatchProcessRequest.BatchInputConfig

Returns
Type	Description
BatchProcessRequest.Builder

addInputConfigs(int index, BatchProcessRequest.BatchInputConfig.Builder builderForValue) (deprecated)

public BatchProcessRequest.Builder addInputConfigs(int index, BatchProcessRequest.BatchInputConfig.Builder builderForValue)

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

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

Parameters
Name	Description
index	int
builderForValue	BatchProcessRequest.BatchInputConfig.Builder

Returns
Type	Description
BatchProcessRequest.Builder

addInputConfigsBuilder() (deprecated)

public BatchProcessRequest.BatchInputConfig.Builder addInputConfigsBuilder()

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
BatchProcessRequest.BatchInputConfig.Builder

addInputConfigsBuilder(int index) (deprecated)

public BatchProcessRequest.BatchInputConfig.Builder addInputConfigsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BatchProcessRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
BatchProcessRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public BatchProcessRequest build()

Returns
Type	Description
BatchProcessRequest

buildPartial()

public BatchProcessRequest buildPartial()

Returns
Type	Description
BatchProcessRequest

clear()

public BatchProcessRequest.Builder clear()

Returns
Type	Description
BatchProcessRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDocumentOutputConfig()

public BatchProcessRequest.Builder clearDocumentOutputConfig()

The output configuration for the BatchProcessDocuments method.

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

Returns
Type	Description
BatchProcessRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public BatchProcessRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
BatchProcessRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearInputConfigs() (deprecated)

public BatchProcessRequest.Builder clearInputConfigs()

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
BatchProcessRequest.Builder

clearInputDocuments()

public BatchProcessRequest.Builder clearInputDocuments()

The input documents for the BatchProcessDocuments method.

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

Returns
Type	Description
BatchProcessRequest.Builder

clearLabels()

public BatchProcessRequest.Builder clearLabels()

Returns
Type	Description
BatchProcessRequest.Builder

clearName()

public BatchProcessRequest.Builder clearName()

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
BatchProcessRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchProcessRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
BatchProcessRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOutputConfig() (deprecated)

public BatchProcessRequest.Builder clearOutputConfig()

The overall output config for batch process.

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

Returns
Type	Description
BatchProcessRequest.Builder

clearProcessOptions()

public BatchProcessRequest.Builder clearProcessOptions()

Inference-time options for the process API

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

Returns
Type	Description
BatchProcessRequest.Builder

clearSkipHumanReview()

public BatchProcessRequest.Builder clearSkipHumanReview()

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

bool skip_human_review = 4;

Returns
Type	Description
BatchProcessRequest.Builder	This builder for chaining.

clone()

public BatchProcessRequest.Builder clone()

Returns
Type	Description
BatchProcessRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsLabels(String key)

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

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getDefaultInstanceForType()

public BatchProcessRequest getDefaultInstanceForType()

Returns
Type	Description
BatchProcessRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDocumentOutputConfig()

public DocumentOutputConfig getDocumentOutputConfig()

The output configuration for the BatchProcessDocuments method.

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

Returns
Type	Description
DocumentOutputConfig	The documentOutputConfig.

getDocumentOutputConfigBuilder()

public DocumentOutputConfig.Builder getDocumentOutputConfigBuilder()

The output configuration for the BatchProcessDocuments method.

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

Returns
Type	Description
DocumentOutputConfig.Builder

getDocumentOutputConfigOrBuilder()

public DocumentOutputConfigOrBuilder getDocumentOutputConfigOrBuilder()

The output configuration for the BatchProcessDocuments method.

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

Returns
Type	Description
DocumentOutputConfigOrBuilder

getInputConfigs(int index) (deprecated)

public 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

getInputConfigsBuilder(int index) (deprecated)

public BatchProcessRequest.BatchInputConfig.Builder getInputConfigsBuilder(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.Builder

getInputConfigsBuilderList() (deprecated)

public List<BatchProcessRequest.BatchInputConfig.Builder> getInputConfigsBuilderList()

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<Builder>

getInputConfigsCount() (deprecated)

public 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() (deprecated)

public 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) (deprecated)

public 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() (deprecated)

public 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 BatchDocumentsInputConfig getInputDocuments()

The input documents for the BatchProcessDocuments method.

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

Returns
Type	Description
BatchDocumentsInputConfig	The inputDocuments.

getInputDocumentsBuilder()

public BatchDocumentsInputConfig.Builder getInputDocumentsBuilder()

The input documents for the BatchProcessDocuments method.

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

Returns
Type	Description
BatchDocumentsInputConfig.Builder

getInputDocumentsOrBuilder()

public BatchDocumentsInputConfigOrBuilder getInputDocumentsOrBuilder()

The input documents for the BatchProcessDocuments method.

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

Returns
Type	Description
BatchDocumentsInputConfigOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

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

Returns
Type	Description
int

getLabelsMap()

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

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

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

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

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

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,String>

getName()

public 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 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 BatchProcessRequest.BatchOutputConfig getOutputConfig()

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

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.

getOutputConfigBuilder() (deprecated)

public BatchProcessRequest.BatchOutputConfig.Builder getOutputConfigBuilder()

The overall output config for batch process.

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

Returns
Type	Description
BatchProcessRequest.BatchOutputConfig.Builder

getOutputConfigOrBuilder() (deprecated)

public 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 ProcessOptions getProcessOptions()

Inference-time options for the process API

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

Returns
Type	Description
ProcessOptions	The processOptions.

getProcessOptionsBuilder()

public ProcessOptions.Builder getProcessOptionsBuilder()

Inference-time options for the process API

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

Returns
Type	Description
ProcessOptions.Builder

getProcessOptionsOrBuilder()

public ProcessOptionsOrBuilder getProcessOptionsOrBuilder()

Inference-time options for the process API

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

Returns
Type	Description
ProcessOptionsOrBuilder

getSkipHumanReview()

public boolean getSkipHumanReview()

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

bool skip_human_review = 4;

Returns
Type	Description
boolean	The skipHumanReview.

hasDocumentOutputConfig()

public boolean hasDocumentOutputConfig()

The output configuration for the BatchProcessDocuments method.

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

Returns
Type	Description
boolean	Whether the documentOutputConfig field is set.

hasInputDocuments()

public boolean hasInputDocuments()

The input documents for the BatchProcessDocuments method.

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

Returns
Type	Description
boolean	Whether the inputDocuments field is set.

hasOutputConfig() (deprecated)

public boolean hasOutputConfig()

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

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeDocumentOutputConfig(DocumentOutputConfig value)

public BatchProcessRequest.Builder mergeDocumentOutputConfig(DocumentOutputConfig value)

The output configuration for the BatchProcessDocuments method.

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

Parameter
Name	Description
value	DocumentOutputConfig

Returns
Type	Description
BatchProcessRequest.Builder

mergeFrom(BatchProcessRequest other)

public BatchProcessRequest.Builder mergeFrom(BatchProcessRequest other)

Parameter
Name	Description
other	BatchProcessRequest

Returns
Type	Description
BatchProcessRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchProcessRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchProcessRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public BatchProcessRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
BatchProcessRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeInputDocuments(BatchDocumentsInputConfig value)

public BatchProcessRequest.Builder mergeInputDocuments(BatchDocumentsInputConfig value)

The input documents for the BatchProcessDocuments method.

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

Parameter
Name	Description
value	BatchDocumentsInputConfig

Returns
Type	Description
BatchProcessRequest.Builder

mergeOutputConfig(BatchProcessRequest.BatchOutputConfig value) (deprecated)

public BatchProcessRequest.Builder mergeOutputConfig(BatchProcessRequest.BatchOutputConfig value)

The overall output config for batch process.

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

Parameter
Name	Description
value	BatchProcessRequest.BatchOutputConfig

Returns
Type	Description
BatchProcessRequest.Builder

mergeProcessOptions(ProcessOptions value)

public BatchProcessRequest.Builder mergeProcessOptions(ProcessOptions value)

Inference-time options for the process API

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

Parameter
Name	Description
value	ProcessOptions

Returns
Type	Description
BatchProcessRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchProcessRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
BatchProcessRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAllLabels(Map<String,String> values)

public BatchProcessRequest.Builder putAllLabels(Map<String,String> values)

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

Parameter
Name	Description
values	Map<String,String>

Returns
Type	Description
BatchProcessRequest.Builder

putLabels(String key, String value)

public BatchProcessRequest.Builder putLabels(String key, String value)

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

Parameters
Name	Description
key	String
value	String

Returns
Type	Description
BatchProcessRequest.Builder

removeInputConfigs(int index) (deprecated)

public BatchProcessRequest.Builder removeInputConfigs(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.Builder

removeLabels(String key)

public BatchProcessRequest.Builder removeLabels(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];

Parameter
Name	Description
key	String

Returns
Type	Description
BatchProcessRequest.Builder

setDocumentOutputConfig(DocumentOutputConfig value)

public BatchProcessRequest.Builder setDocumentOutputConfig(DocumentOutputConfig value)

The output configuration for the BatchProcessDocuments method.

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

Parameter
Name	Description
value	DocumentOutputConfig

Returns
Type	Description
BatchProcessRequest.Builder

setDocumentOutputConfig(DocumentOutputConfig.Builder builderForValue)

public BatchProcessRequest.Builder setDocumentOutputConfig(DocumentOutputConfig.Builder builderForValue)

The output configuration for the BatchProcessDocuments method.

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

Parameter
Name	Description
builderForValue	DocumentOutputConfig.Builder

Returns
Type	Description
BatchProcessRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public BatchProcessRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
BatchProcessRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setInputConfigs(int index, BatchProcessRequest.BatchInputConfig value) (deprecated)

public BatchProcessRequest.Builder setInputConfigs(int index, BatchProcessRequest.BatchInputConfig value)

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

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

Parameters
Name	Description
index	int
value	BatchProcessRequest.BatchInputConfig

Returns
Type	Description
BatchProcessRequest.Builder

setInputConfigs(int index, BatchProcessRequest.BatchInputConfig.Builder builderForValue) (deprecated)

public BatchProcessRequest.Builder setInputConfigs(int index, BatchProcessRequest.BatchInputConfig.Builder builderForValue)

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

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

Parameters
Name	Description
index	int
builderForValue	BatchProcessRequest.BatchInputConfig.Builder

Returns
Type	Description
BatchProcessRequest.Builder

setInputDocuments(BatchDocumentsInputConfig value)

public BatchProcessRequest.Builder setInputDocuments(BatchDocumentsInputConfig value)

The input documents for the BatchProcessDocuments method.

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

Parameter
Name	Description
value	BatchDocumentsInputConfig

Returns
Type	Description
BatchProcessRequest.Builder

setInputDocuments(BatchDocumentsInputConfig.Builder builderForValue)

public BatchProcessRequest.Builder setInputDocuments(BatchDocumentsInputConfig.Builder builderForValue)

The input documents for the BatchProcessDocuments method.

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

Parameter
Name	Description
builderForValue	BatchDocumentsInputConfig.Builder

Returns
Type	Description
BatchProcessRequest.Builder

setName(String value)

public BatchProcessRequest.Builder setName(String value)

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) = { ... }

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
BatchProcessRequest.Builder	This builder for chaining.

setNameBytes(ByteString value)

public BatchProcessRequest.Builder setNameBytes(ByteString value)

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) = { ... }

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
BatchProcessRequest.Builder	This builder for chaining.

setOutputConfig(BatchProcessRequest.BatchOutputConfig value) (deprecated)

public BatchProcessRequest.Builder setOutputConfig(BatchProcessRequest.BatchOutputConfig value)

The overall output config for batch process.

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

Parameter
Name	Description
value	BatchProcessRequest.BatchOutputConfig

Returns
Type	Description
BatchProcessRequest.Builder

setOutputConfig(BatchProcessRequest.BatchOutputConfig.Builder builderForValue) (deprecated)

public BatchProcessRequest.Builder setOutputConfig(BatchProcessRequest.BatchOutputConfig.Builder builderForValue)

The overall output config for batch process.

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

Parameter
Name	Description
builderForValue	BatchProcessRequest.BatchOutputConfig.Builder

Returns
Type	Description
BatchProcessRequest.Builder

setProcessOptions(ProcessOptions value)

public BatchProcessRequest.Builder setProcessOptions(ProcessOptions value)

Inference-time options for the process API

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

Parameter
Name	Description
value	ProcessOptions

Returns
Type	Description
BatchProcessRequest.Builder

setProcessOptions(ProcessOptions.Builder builderForValue)

public BatchProcessRequest.Builder setProcessOptions(ProcessOptions.Builder builderForValue)

Inference-time options for the process API

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

Parameter
Name	Description
builderForValue	ProcessOptions.Builder

Returns
Type	Description
BatchProcessRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BatchProcessRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
BatchProcessRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSkipHumanReview(boolean value)

public BatchProcessRequest.Builder setSkipHumanReview(boolean value)

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

bool skip_human_review = 4;

Parameter
Name	Description
value	boolean The skipHumanReview to set.

Returns
Type	Description
BatchProcessRequest.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchProcessRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
BatchProcessRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)