Class BatchProcessRequest (2.47.0)

public final class BatchProcessRequest extends GeneratedMessageV3 implements BatchProcessRequestOrBuilder

Request message for BatchProcessDocuments.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessRequest

Static Fields

DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER

public static final int DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

INPUT_CONFIGS_FIELD_NUMBER

public static final int INPUT_CONFIGS_FIELD_NUMBER
Field Value
Type Description
int

INPUT_DOCUMENTS_FIELD_NUMBER

public static final int INPUT_DOCUMENTS_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_CONFIG_FIELD_NUMBER

public static final int OUTPUT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PROCESS_OPTIONS_FIELD_NUMBER

public static final int PROCESS_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

SKIP_HUMAN_REVIEW_FIELD_NUMBER

public static final int SKIP_HUMAN_REVIEW_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BatchProcessRequest getDefaultInstance()
Returns
Type Description
BatchProcessRequest

getDescriptor()

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

newBuilder()

public static BatchProcessRequest.Builder newBuilder()
Returns
Type Description
BatchProcessRequest.Builder

newBuilder(BatchProcessRequest prototype)

public static BatchProcessRequest.Builder newBuilder(BatchProcessRequest prototype)
Parameter
Name Description
prototype BatchProcessRequest
Returns
Type Description
BatchProcessRequest.Builder

parseDelimitedFrom(InputStream input)

public static BatchProcessRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BatchProcessRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchProcessRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchProcessRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BatchProcessRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BatchProcessRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchProcessRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchProcessRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BatchProcessRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BatchProcessRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchProcessRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchProcessRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BatchProcessRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BatchProcessRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchProcessRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchProcessRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BatchProcessRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BatchProcessRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchProcessRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchProcessRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BatchProcessRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BatchProcessRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchProcessRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchProcessRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BatchProcessRequest> parser()
Returns
Type Description
Parser<BatchProcessRequest>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public BatchProcessRequest getDefaultInstanceForType()
Returns
Type Description
BatchProcessRequest

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.

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

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.

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

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.

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

getParserForType()

public Parser<BatchProcessRequest> getParserForType()
Returns
Type Description
Parser<BatchProcessRequest>
Overrides

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.

getProcessOptionsOrBuilder()

public ProcessOptionsOrBuilder getProcessOptionsOrBuilder()

Inference-time options for the process API

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

Returns
Type Description
ProcessOptionsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BatchProcessRequest.Builder newBuilderForType()
Returns
Type Description
BatchProcessRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BatchProcessRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BatchProcessRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BatchProcessRequest.Builder toBuilder()
Returns
Type Description
BatchProcessRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException