Class BatchProcessDocumentsRequest.Builder (2.53.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BatchProcessDocumentsRequest.Builder

Implements

BatchProcessDocumentsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`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
Name	Description
`values`	`Iterable<? extends com.google.cloud.documentai.v1beta2.ProcessDocumentRequest>`

Returns
Type	Description
`BatchProcessDocumentsRequest.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BatchProcessDocumentsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`BatchProcessDocumentsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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
Name	Description
`value`	`ProcessDocumentRequest`

Returns
Type	Description
`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
Name	Description
`builderForValue`	`ProcessDocumentRequest.Builder`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`value`	`ProcessDocumentRequest`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`builderForValue`	`ProcessDocumentRequest.Builder`

Returns
Type	Description
`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
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`ProcessDocumentRequest.Builder`

build()

public BatchProcessDocumentsRequest build()

Returns
Type	Description
`BatchProcessDocumentsRequest`

buildPartial()

public BatchProcessDocumentsRequest buildPartial()

Returns
Type	Description
`BatchProcessDocumentsRequest`

clear()

public BatchProcessDocumentsRequest.Builder clear()

Returns
Type	Description
`BatchProcessDocumentsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public BatchProcessDocumentsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`BatchProcessDocumentsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchProcessDocumentsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`BatchProcessDocumentsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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
Type	Description
`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
Type	Description
`BatchProcessDocumentsRequest.Builder`

clone()

public BatchProcessDocumentsRequest.Builder clone()

Returns
Type	Description
`BatchProcessDocumentsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public BatchProcessDocumentsRequest getDefaultInstanceForType()

Returns
Type	Description
`BatchProcessDocumentsRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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
Type	Description
`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
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Type	Description
`List<? extends com.google.cloud.documentai.v1beta2.ProcessDocumentRequestOrBuilder>`

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(BatchProcessDocumentsRequest other)

public BatchProcessDocumentsRequest.Builder mergeFrom(BatchProcessDocumentsRequest other)

Parameter
Name	Description
`other`	`BatchProcessDocumentsRequest`

Returns
Type	Description
`BatchProcessDocumentsRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchProcessDocumentsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BatchProcessDocumentsRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public BatchProcessDocumentsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`BatchProcessDocumentsRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchProcessDocumentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`BatchProcessDocumentsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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
Name	Description
`index`	`int`

Returns
Type	Description
`BatchProcessDocumentsRequest.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public BatchProcessDocumentsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`BatchProcessDocumentsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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
Name	Description
`value`	`String` The parent to set.

Returns
Type	Description
`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
Name	Description
`value`	`ByteString` The bytes for parent to set.

Returns
Type	Description
`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
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`BatchProcessDocumentsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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
Name	Description
`index`	`int`
`value`	`ProcessDocumentRequest`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`builderForValue`	`ProcessDocumentRequest.Builder`

Returns
Type	Description
`BatchProcessDocumentsRequest.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchProcessDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`BatchProcessDocumentsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)