Class BatchProcessRequest (2.41.0)

public final class BatchProcessRequest extends GeneratedMessageV3 implements BatchProcessRequestOrBuilder

Request message for BatchProcessDocuments.

Protobuf type google.cloud.documentai.v1.BatchProcessRequest

Static Fields

DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER

public static final int DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

INPUT_DOCUMENTS_FIELD_NUMBER

public static final int INPUT_DOCUMENTS_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PROCESS_OPTIONS_FIELD_NUMBER

public static final int PROCESS_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

SKIP_HUMAN_REVIEW_FIELD_NUMBER

public static final int SKIP_HUMAN_REVIEW_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BatchProcessRequest getDefaultInstance()
Returns
TypeDescription
BatchProcessRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static BatchProcessRequest.Builder newBuilder()
Returns
TypeDescription
BatchProcessRequest.Builder

newBuilder(BatchProcessRequest prototype)

public static BatchProcessRequest.Builder newBuilder(BatchProcessRequest prototype)
Parameter
NameDescription
prototypeBatchProcessRequest
Returns
TypeDescription
BatchProcessRequest.Builder

parseDelimitedFrom(InputStream input)

public static BatchProcessRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BatchProcessRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchProcessRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchProcessRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static BatchProcessRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
BatchProcessRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchProcessRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchProcessRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BatchProcessRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BatchProcessRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchProcessRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchProcessRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BatchProcessRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BatchProcessRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchProcessRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchProcessRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static BatchProcessRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BatchProcessRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchProcessRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchProcessRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static BatchProcessRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BatchProcessRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchProcessRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchProcessRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<BatchProcessRequest> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public BatchProcessRequest getDefaultInstanceForType()
Returns
TypeDescription
BatchProcessRequest

getDocumentOutputConfig()

public DocumentOutputConfig getDocumentOutputConfig()

The output configuration for the BatchProcessDocuments method.

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

Returns
TypeDescription
DocumentOutputConfig

The documentOutputConfig.

getDocumentOutputConfigOrBuilder()

public DocumentOutputConfigOrBuilder getDocumentOutputConfigOrBuilder()

The output configuration for the BatchProcessDocuments method.

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

Returns
TypeDescription
DocumentOutputConfigOrBuilder

getInputDocuments()

public BatchDocumentsInputConfig getInputDocuments()

The input documents for the BatchProcessDocuments method.

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

Returns
TypeDescription
BatchDocumentsInputConfig

The inputDocuments.

getInputDocumentsOrBuilder()

public BatchDocumentsInputConfigOrBuilder getInputDocumentsOrBuilder()

The input documents for the BatchProcessDocuments method.

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

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.

getParserForType()

public Parser<BatchProcessRequest> getParserForType()
Returns
TypeDescription
Parser<BatchProcessRequest>
Overrides

getProcessOptions()

public ProcessOptions getProcessOptions()

Inference-time options for the process API

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

Returns
TypeDescription
ProcessOptions

The processOptions.

getProcessOptionsOrBuilder()

public ProcessOptionsOrBuilder getProcessOptionsOrBuilder()

Inference-time options for the process API

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

Returns
TypeDescription
ProcessOptionsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

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

Whether the processOptions field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public BatchProcessRequest.Builder newBuilderForType()
Returns
TypeDescription
BatchProcessRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BatchProcessRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
BatchProcessRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public BatchProcessRequest.Builder toBuilder()
Returns
TypeDescription
BatchProcessRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException