Class BatchProcessDocumentsRequest (2.43.0)

public final class BatchProcessDocumentsRequest extends GeneratedMessageV3 implements BatchProcessDocumentsRequestOrBuilder

Request to batch process documents as an asynchronous operation. The output is written to Cloud Storage as JSON in the [Document] format.

Protobuf type google.cloud.documentai.v1beta2.BatchProcessDocumentsRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

REQUESTS_FIELD_NUMBER

public static final int REQUESTS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BatchProcessDocumentsRequest getDefaultInstance()
Returns
TypeDescription
BatchProcessDocumentsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(BatchProcessDocumentsRequest prototype)

public static BatchProcessDocumentsRequest.Builder newBuilder(BatchProcessDocumentsRequest prototype)
Parameter
NameDescription
prototypeBatchProcessDocumentsRequest
Returns
TypeDescription
BatchProcessDocumentsRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<BatchProcessDocumentsRequest> parser()
Returns
TypeDescription
Parser<BatchProcessDocumentsRequest>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public BatchProcessDocumentsRequest getDefaultInstanceForType()
Returns
TypeDescription
BatchProcessDocumentsRequest

getParent()

public String getParent()

Target project and location to make a call.

Format: projects/{project-id}/locations/{location-id}.

If no location is specified, a region will be chosen automatically.

string parent = 2;

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Target project and location to make a call.

Format: projects/{project-id}/locations/{location-id}.

If no location is specified, a region will be chosen automatically.

string parent = 2;

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

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

getRequests(int index)

public ProcessDocumentRequest getRequests(int index)

Required. Individual requests for each document.

repeated .google.cloud.documentai.v1beta2.ProcessDocumentRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
ProcessDocumentRequest

getRequestsCount()

public int getRequestsCount()

Required. Individual requests for each document.

repeated .google.cloud.documentai.v1beta2.ProcessDocumentRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

getRequestsList()

public List<ProcessDocumentRequest> getRequestsList()

Required. Individual requests for each document.

repeated .google.cloud.documentai.v1beta2.ProcessDocumentRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<ProcessDocumentRequest>

getRequestsOrBuilder(int index)

public ProcessDocumentRequestOrBuilder getRequestsOrBuilder(int index)

Required. Individual requests for each document.

repeated .google.cloud.documentai.v1beta2.ProcessDocumentRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
ProcessDocumentRequestOrBuilder

getRequestsOrBuilderList()

public List<? extends ProcessDocumentRequestOrBuilder> getRequestsOrBuilderList()

Required. Individual requests for each document.

repeated .google.cloud.documentai.v1beta2.ProcessDocumentRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1beta2.ProcessDocumentRequestOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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