Class BatchProcessDocumentsRequest.Builder (2.31.0)

public static final class BatchProcessDocumentsRequest.Builder extends GeneratedMessageV3.Builder<BatchProcessDocumentsRequest.Builder> 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 Methods

getDescriptor()

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

Methods

addAllRequests(Iterable<? extends ProcessDocumentRequest> values)

public BatchProcessDocumentsRequest.Builder addAllRequests(Iterable<? extends ProcessDocumentRequest> values)

Required. Individual requests for each document.

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.documentai.v1beta2.ProcessDocumentRequest>
Returns
TypeDescription
BatchProcessDocumentsRequest.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addRequests(ProcessDocumentRequest value)

public BatchProcessDocumentsRequest.Builder addRequests(ProcessDocumentRequest value)

Required. Individual requests for each document.

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

Parameter
NameDescription
valueProcessDocumentRequest
Returns
TypeDescription
BatchProcessDocumentsRequest.Builder

addRequests(ProcessDocumentRequest.Builder builderForValue)

public BatchProcessDocumentsRequest.Builder addRequests(ProcessDocumentRequest.Builder builderForValue)

Required. Individual requests for each document.

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

Parameter
NameDescription
builderForValueProcessDocumentRequest.Builder
Returns
TypeDescription
BatchProcessDocumentsRequest.Builder

addRequests(int index, ProcessDocumentRequest value)

public BatchProcessDocumentsRequest.Builder addRequests(int index, ProcessDocumentRequest value)

Required. Individual requests for each document.

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

Parameters
NameDescription
indexint
valueProcessDocumentRequest
Returns
TypeDescription
BatchProcessDocumentsRequest.Builder

addRequests(int index, ProcessDocumentRequest.Builder builderForValue)

public BatchProcessDocumentsRequest.Builder addRequests(int index, ProcessDocumentRequest.Builder builderForValue)

Required. Individual requests for each document.

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

Parameters
NameDescription
indexint
builderForValueProcessDocumentRequest.Builder
Returns
TypeDescription
BatchProcessDocumentsRequest.Builder

addRequestsBuilder()

public ProcessDocumentRequest.Builder addRequestsBuilder()

Required. Individual requests for each document.

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

Returns
TypeDescription
ProcessDocumentRequest.Builder

addRequestsBuilder(int index)

public ProcessDocumentRequest.Builder addRequestsBuilder(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.Builder

build()

public BatchProcessDocumentsRequest build()
Returns
TypeDescription
BatchProcessDocumentsRequest

buildPartial()

public BatchProcessDocumentsRequest buildPartial()
Returns
TypeDescription
BatchProcessDocumentsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParent()

public BatchProcessDocumentsRequest.Builder clearParent()

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
BatchProcessDocumentsRequest.Builder

This builder for chaining.

clearRequests()

public BatchProcessDocumentsRequest.Builder clearRequests()

Required. Individual requests for each document.

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

Returns
TypeDescription
BatchProcessDocumentsRequest.Builder

clone()

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

getDefaultInstanceForType()

public BatchProcessDocumentsRequest getDefaultInstanceForType()
Returns
TypeDescription
BatchProcessDocumentsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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

getRequestsBuilder(int index)

public ProcessDocumentRequest.Builder getRequestsBuilder(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.Builder

getRequestsBuilderList()

public List<ProcessDocumentRequest.Builder> getRequestsBuilderList()

Required. Individual requests for each document.

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

Returns
TypeDescription
List<Builder>

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>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(BatchProcessDocumentsRequest other)

public BatchProcessDocumentsRequest.Builder mergeFrom(BatchProcessDocumentsRequest other)
Parameter
NameDescription
otherBatchProcessDocumentsRequest
Returns
TypeDescription
BatchProcessDocumentsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeRequests(int index)

public BatchProcessDocumentsRequest.Builder removeRequests(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
BatchProcessDocumentsRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setParent(String value)

public BatchProcessDocumentsRequest.Builder setParent(String value)

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;

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
BatchProcessDocumentsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public BatchProcessDocumentsRequest.Builder setParentBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
BatchProcessDocumentsRequest.Builder

This builder for chaining.

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

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

setRequests(int index, ProcessDocumentRequest value)

public BatchProcessDocumentsRequest.Builder setRequests(int index, ProcessDocumentRequest value)

Required. Individual requests for each document.

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

Parameters
NameDescription
indexint
valueProcessDocumentRequest
Returns
TypeDescription
BatchProcessDocumentsRequest.Builder

setRequests(int index, ProcessDocumentRequest.Builder builderForValue)

public BatchProcessDocumentsRequest.Builder setRequests(int index, ProcessDocumentRequest.Builder builderForValue)

Required. Individual requests for each document.

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

Parameters
NameDescription
indexint
builderForValueProcessDocumentRequest.Builder
Returns
TypeDescription
BatchProcessDocumentsRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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