Class BatchProcessRequest.Builder (2.50.0)

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

Request message for BatchProcessDocuments.

Protobuf type google.cloud.documentai.v1.BatchProcessRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

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

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

clearDocumentOutputConfig()

public BatchProcessRequest.Builder clearDocumentOutputConfig()

The output configuration for the BatchProcessDocuments method.

.google.cloud.documentai.v1.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

clearInputDocuments()

public BatchProcessRequest.Builder clearInputDocuments()

The input documents for the BatchProcessDocuments method.

.google.cloud.documentai.v1.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

clearProcessOptions()

public BatchProcessRequest.Builder clearProcessOptions()

Inference-time options for the process API

.google.cloud.documentai.v1.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

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

getDocumentOutputConfig()

public DocumentOutputConfig getDocumentOutputConfig()

The output configuration for the BatchProcessDocuments method.

.google.cloud.documentai.v1.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.v1.DocumentOutputConfig document_output_config = 6;

Returns
Type Description
DocumentOutputConfig.Builder

getDocumentOutputConfigOrBuilder()

public DocumentOutputConfigOrBuilder getDocumentOutputConfigOrBuilder()

The output configuration for the BatchProcessDocuments method.

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

Returns
Type Description
DocumentOutputConfigOrBuilder

getInputDocuments()

public BatchDocumentsInputConfig getInputDocuments()

The input documents for the BatchProcessDocuments method.

.google.cloud.documentai.v1.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.v1.BatchDocumentsInputConfig input_documents = 5;

Returns
Type Description
BatchDocumentsInputConfig.Builder

getInputDocumentsOrBuilder()

public BatchDocumentsInputConfigOrBuilder getInputDocumentsOrBuilder()

The input documents for the BatchProcessDocuments method.

.google.cloud.documentai.v1.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.

getProcessOptions()

public ProcessOptions getProcessOptions()

Inference-time options for the process API

.google.cloud.documentai.v1.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.v1.ProcessOptions process_options = 7;

Returns
Type Description
ProcessOptions.Builder

getProcessOptionsOrBuilder()

public ProcessOptionsOrBuilder getProcessOptionsOrBuilder()

Inference-time options for the process API

.google.cloud.documentai.v1.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.v1.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.v1.BatchDocumentsInputConfig input_documents = 5;

Returns
Type Description
boolean

Whether the inputDocuments field is set.

hasProcessOptions()

public boolean hasProcessOptions()

Inference-time options for the process API

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

Returns
Type Description
boolean

Whether the processOptions field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

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

mergeDocumentOutputConfig(DocumentOutputConfig value)

public BatchProcessRequest.Builder mergeDocumentOutputConfig(DocumentOutputConfig value)

The output configuration for the BatchProcessDocuments method.

.google.cloud.documentai.v1.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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BatchProcessRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BatchProcessRequest.Builder
Overrides

mergeInputDocuments(BatchDocumentsInputConfig value)

public BatchProcessRequest.Builder mergeInputDocuments(BatchDocumentsInputConfig value)

The input documents for the BatchProcessDocuments method.

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

Parameter
Name Description
value BatchDocumentsInputConfig
Returns
Type Description
BatchProcessRequest.Builder

mergeProcessOptions(ProcessOptions value)

public BatchProcessRequest.Builder mergeProcessOptions(ProcessOptions value)

Inference-time options for the process API

.google.cloud.documentai.v1.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

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

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

setInputDocuments(BatchDocumentsInputConfig value)

public BatchProcessRequest.Builder setInputDocuments(BatchDocumentsInputConfig value)

The input documents for the BatchProcessDocuments method.

.google.cloud.documentai.v1.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.v1.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.

setProcessOptions(ProcessOptions value)

public BatchProcessRequest.Builder setProcessOptions(ProcessOptions value)

Inference-time options for the process API

.google.cloud.documentai.v1.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.v1.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

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