Class BatchProcessRequest.Builder (2.41.0)

public static final class BatchProcessRequest.Builder extends GeneratedMessageV3.Builder<BatchProcessRequest.Builder> implements BatchProcessRequestOrBuilder

Request message for BatchProcessDocuments.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig>
Returns
TypeDescription
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
NameDescription
valueBatchProcessRequest.BatchInputConfig
Returns
TypeDescription
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
NameDescription
builderForValueBatchProcessRequest.BatchInputConfig.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueBatchProcessRequest.BatchInputConfig
Returns
TypeDescription
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
NameDescription
indexint
builderForValueBatchProcessRequest.BatchInputConfig.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
BatchProcessRequest.BatchInputConfig.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BatchProcessRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BatchProcessRequest.Builder
Overrides

build()

public BatchProcessRequest build()
Returns
TypeDescription
BatchProcessRequest

buildPartial()

public BatchProcessRequest buildPartial()
Returns
TypeDescription
BatchProcessRequest

clear()

public BatchProcessRequest.Builder clear()
Returns
TypeDescription
BatchProcessRequest.Builder
Overrides

clearDocumentOutputConfig()

public BatchProcessRequest.Builder clearDocumentOutputConfig()

The output configuration for the BatchProcessDocuments method.

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

Returns
TypeDescription
BatchProcessRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public BatchProcessRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
BatchProcessRequest.Builder
Overrides

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

clearInputDocuments()

public BatchProcessRequest.Builder clearInputDocuments()

The input documents for the BatchProcessDocuments method.

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

Returns
TypeDescription
BatchProcessRequest.Builder

clearLabels()

public BatchProcessRequest.Builder clearLabels()
Returns
TypeDescription
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
TypeDescription
BatchProcessRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchProcessRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
BatchProcessRequest.Builder
Overrides

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

clearProcessOptions()

public BatchProcessRequest.Builder clearProcessOptions()

Inference-time options for the process API

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

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

This builder for chaining.

clone()

public BatchProcessRequest.Builder clone()
Returns
TypeDescription
BatchProcessRequest.Builder
Overrides

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
NameDescription
keyString
Returns
TypeDescription
boolean

getDefaultInstanceForType()

public BatchProcessRequest getDefaultInstanceForType()
Returns
TypeDescription
BatchProcessRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDocumentOutputConfig()

public DocumentOutputConfig getDocumentOutputConfig()

The output configuration for the BatchProcessDocuments method.

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

Returns
TypeDescription
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
TypeDescription
DocumentOutputConfig.Builder

getDocumentOutputConfigOrBuilder()

public DocumentOutputConfigOrBuilder getDocumentOutputConfigOrBuilder()

The output configuration for the BatchProcessDocuments method.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
BatchDocumentsInputConfig

The inputDocuments.

getInputDocumentsBuilder()

public BatchDocumentsInputConfig.Builder getInputDocumentsBuilder()

The input documents for the BatchProcessDocuments method.

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

Returns
TypeDescription
BatchDocumentsInputConfig.Builder

getInputDocumentsOrBuilder()

public BatchDocumentsInputConfigOrBuilder getInputDocumentsOrBuilder()

The input documents for the BatchProcessDocuments method.

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

Returns
TypeDescription
BatchDocumentsInputConfigOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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=541

The overall output config for batch process.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
BatchProcessRequest.BatchOutputConfigOrBuilder

getProcessOptions()

public ProcessOptions getProcessOptions()

Inference-time options for the process API

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

Returns
TypeDescription
ProcessOptions

The processOptions.

getProcessOptionsBuilder()

public ProcessOptions.Builder getProcessOptionsBuilder()

Inference-time options for the process API

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

Returns
TypeDescription
ProcessOptions.Builder

getProcessOptionsOrBuilder()

public ProcessOptionsOrBuilder getProcessOptionsOrBuilder()

Inference-time options for the process API

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

Returns
TypeDescription
ProcessOptionsOrBuilder

getSkipHumanReview()

public boolean getSkipHumanReview()

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

bool skip_human_review = 4;

Returns
TypeDescription
boolean

The skipHumanReview.

hasDocumentOutputConfig()

public boolean hasDocumentOutputConfig()

The output configuration for the BatchProcessDocuments method.

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

Returns
TypeDescription
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
TypeDescription
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=541

The overall output config for batch process.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the processOptions field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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
NameDescription
valueDocumentOutputConfig
Returns
TypeDescription
BatchProcessRequest.Builder

mergeFrom(BatchProcessRequest other)

public BatchProcessRequest.Builder mergeFrom(BatchProcessRequest other)
Parameter
NameDescription
otherBatchProcessRequest
Returns
TypeDescription
BatchProcessRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchProcessRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchProcessRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public BatchProcessRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
BatchProcessRequest.Builder
Overrides

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
NameDescription
valueBatchDocumentsInputConfig
Returns
TypeDescription
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
NameDescription
valueBatchProcessRequest.BatchOutputConfig
Returns
TypeDescription
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
NameDescription
valueProcessOptions
Returns
TypeDescription
BatchProcessRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchProcessRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BatchProcessRequest.Builder
Overrides

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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
valueDocumentOutputConfig
Returns
TypeDescription
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
NameDescription
builderForValueDocumentOutputConfig.Builder
Returns
TypeDescription
BatchProcessRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public BatchProcessRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BatchProcessRequest.Builder
Overrides

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
NameDescription
indexint
valueBatchProcessRequest.BatchInputConfig
Returns
TypeDescription
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
NameDescription
indexint
builderForValueBatchProcessRequest.BatchInputConfig.Builder
Returns
TypeDescription
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
NameDescription
valueBatchDocumentsInputConfig
Returns
TypeDescription
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
NameDescription
builderForValueBatchDocumentsInputConfig.Builder
Returns
TypeDescription
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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
valueBatchProcessRequest.BatchOutputConfig
Returns
TypeDescription
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
NameDescription
builderForValueBatchProcessRequest.BatchOutputConfig.Builder
Returns
TypeDescription
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
NameDescription
valueProcessOptions
Returns
TypeDescription
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
NameDescription
builderForValueProcessOptions.Builder
Returns
TypeDescription
BatchProcessRequest.Builder

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

public BatchProcessRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
BatchProcessRequest.Builder
Overrides

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
NameDescription
valueboolean

The skipHumanReview to set.

Returns
TypeDescription
BatchProcessRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchProcessRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BatchProcessRequest.Builder
Overrides