com.google.cloud.documentai.v1

Class BatchProcessRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<BatchProcessRequest.Builder>

com.google.cloud.documentai.v1.BatchProcessRequest.Builder

All Implemented Interfaces:

BatchProcessRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

BatchProcessRequest

public static final class BatchProcessRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<BatchProcessRequest.Builder>
implements BatchProcessRequestOrBuilder

 Request message for batch process document method.
 

Protobuf type google.cloud.documentai.v1.BatchProcessRequest

Method Summary

Modifier and Type	Method and Description
BatchProcessRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
BatchProcessRequest	build()
BatchProcessRequest	buildPartial()
BatchProcessRequest.Builder	clear()
BatchProcessRequest.Builder	clearDocumentOutputConfig() The overall output config for batch process.
BatchProcessRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
BatchProcessRequest.Builder	clearInputDocuments() The input documents for batch process.
BatchProcessRequest.Builder	clearName() Required.
BatchProcessRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
BatchProcessRequest.Builder	clearSkipHumanReview() Whether Human Review feature should be skipped for this request.
BatchProcessRequest.Builder	clone()
BatchProcessRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
DocumentOutputConfig	getDocumentOutputConfig() The overall output config for batch process.
DocumentOutputConfig.Builder	getDocumentOutputConfigBuilder() The overall output config for batch process.
DocumentOutputConfigOrBuilder	getDocumentOutputConfigOrBuilder() The overall output config for batch process.
BatchDocumentsInputConfig	getInputDocuments() The input documents for batch process.
BatchDocumentsInputConfig.Builder	getInputDocumentsBuilder() The input documents for batch process.
BatchDocumentsInputConfigOrBuilder	getInputDocumentsOrBuilder() The input documents for batch process.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
boolean	getSkipHumanReview() Whether Human Review feature should be skipped for this request.
boolean	hasDocumentOutputConfig() The overall output config for batch process.
boolean	hasInputDocuments() The input documents for batch process.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
BatchProcessRequest.Builder	mergeDocumentOutputConfig(DocumentOutputConfig value) The overall output config for batch process.
BatchProcessRequest.Builder	mergeFrom(BatchProcessRequest other)
BatchProcessRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
BatchProcessRequest.Builder	mergeFrom(com.google.protobuf.Message other)
BatchProcessRequest.Builder	mergeInputDocuments(BatchDocumentsInputConfig value) The input documents for batch process.
BatchProcessRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
BatchProcessRequest.Builder	setDocumentOutputConfig(DocumentOutputConfig.Builder builderForValue) The overall output config for batch process.
BatchProcessRequest.Builder	setDocumentOutputConfig(DocumentOutputConfig value) The overall output config for batch process.
BatchProcessRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
BatchProcessRequest.Builder	setInputDocuments(BatchDocumentsInputConfig.Builder builderForValue) The input documents for batch process.
BatchProcessRequest.Builder	setInputDocuments(BatchDocumentsInputConfig value) The input documents for batch process.
BatchProcessRequest.Builder	setName(String value) Required.
BatchProcessRequest.Builder	setNameBytes(com.google.protobuf.ByteString value) Required.
BatchProcessRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
BatchProcessRequest.Builder	setSkipHumanReview(boolean value) Whether Human Review feature should be skipped for this request.
BatchProcessRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<BatchProcessRequest.Builder>

clear

public BatchProcessRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<BatchProcessRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<BatchProcessRequest.Builder>

getDefaultInstanceForType

public BatchProcessRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public BatchProcessRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public BatchProcessRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public BatchProcessRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<BatchProcessRequest.Builder>

setField

public BatchProcessRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchProcessRequest.Builder>

clearField

public BatchProcessRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchProcessRequest.Builder>

clearOneof

public BatchProcessRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<BatchProcessRequest.Builder>

setRepeatedField

public BatchProcessRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    int index,
                                                    Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchProcessRequest.Builder>

addRepeatedField

public BatchProcessRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchProcessRequest.Builder>

mergeFrom

public BatchProcessRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BatchProcessRequest.Builder>

mergeFrom

public BatchProcessRequest.Builder mergeFrom(BatchProcessRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<BatchProcessRequest.Builder>

mergeFrom

public BatchProcessRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BatchProcessRequest.Builder>

Throws:

IOException

getName

public String getName()

 Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1.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) = { ... }

Specified by:

getName in interface BatchProcessRequestOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1.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) = { ... }

Specified by:

getNameBytes in interface BatchProcessRequestOrBuilder

Returns:

The bytes for name.

setName

public BatchProcessRequest.Builder setName(String value)

 Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1.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) = { ... }

Parameters:

value - The name to set.

Returns:

This builder for chaining.

clearName

public BatchProcessRequest.Builder clearName()

 Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1.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:

This builder for chaining.

setNameBytes

public BatchProcessRequest.Builder setNameBytes(com.google.protobuf.ByteString value)

 Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1.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) = { ... }

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

hasInputDocuments

public boolean hasInputDocuments()

 The input documents for batch process.
 

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

Specified by:

hasInputDocuments in interface BatchProcessRequestOrBuilder

Returns:

Whether the inputDocuments field is set.

getInputDocuments

public BatchDocumentsInputConfig getInputDocuments()

 The input documents for batch process.
 

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

Specified by:

getInputDocuments in interface BatchProcessRequestOrBuilder

Returns:

The inputDocuments.

setInputDocuments

public BatchProcessRequest.Builder setInputDocuments(BatchDocumentsInputConfig value)

 The input documents for batch process.
 

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

setInputDocuments

public BatchProcessRequest.Builder setInputDocuments(BatchDocumentsInputConfig.Builder builderForValue)

 The input documents for batch process.
 

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

mergeInputDocuments

public BatchProcessRequest.Builder mergeInputDocuments(BatchDocumentsInputConfig value)

 The input documents for batch process.
 

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

clearInputDocuments

public BatchProcessRequest.Builder clearInputDocuments()

 The input documents for batch process.
 

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

getInputDocumentsBuilder

public BatchDocumentsInputConfig.Builder getInputDocumentsBuilder()

 The input documents for batch process.
 

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

getInputDocumentsOrBuilder

public BatchDocumentsInputConfigOrBuilder getInputDocumentsOrBuilder()

 The input documents for batch process.
 

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

Specified by:

getInputDocumentsOrBuilder in interface BatchProcessRequestOrBuilder

hasDocumentOutputConfig

public boolean hasDocumentOutputConfig()

 The overall output config for batch process.
 

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

Specified by:

hasDocumentOutputConfig in interface BatchProcessRequestOrBuilder

Returns:

Whether the documentOutputConfig field is set.

getDocumentOutputConfig

public DocumentOutputConfig getDocumentOutputConfig()

 The overall output config for batch process.
 

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

Specified by:

getDocumentOutputConfig in interface BatchProcessRequestOrBuilder

Returns:

The documentOutputConfig.

setDocumentOutputConfig

public BatchProcessRequest.Builder setDocumentOutputConfig(DocumentOutputConfig value)

 The overall output config for batch process.
 

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

setDocumentOutputConfig

public BatchProcessRequest.Builder setDocumentOutputConfig(DocumentOutputConfig.Builder builderForValue)

 The overall output config for batch process.
 

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

mergeDocumentOutputConfig

public BatchProcessRequest.Builder mergeDocumentOutputConfig(DocumentOutputConfig value)

 The overall output config for batch process.
 

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

clearDocumentOutputConfig

public BatchProcessRequest.Builder clearDocumentOutputConfig()

 The overall output config for batch process.
 

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

getDocumentOutputConfigBuilder

public DocumentOutputConfig.Builder getDocumentOutputConfigBuilder()

 The overall output config for batch process.
 

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

getDocumentOutputConfigOrBuilder

public DocumentOutputConfigOrBuilder getDocumentOutputConfigOrBuilder()

 The overall output config for batch process.
 

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

Specified by:

getDocumentOutputConfigOrBuilder in interface BatchProcessRequestOrBuilder

getSkipHumanReview

public boolean getSkipHumanReview()

 Whether Human Review feature should be skipped for this request. Default to
 false.
 

bool skip_human_review = 4;

Specified by:

getSkipHumanReview in interface BatchProcessRequestOrBuilder

Returns:

The skipHumanReview.

setSkipHumanReview

public BatchProcessRequest.Builder setSkipHumanReview(boolean value)

 Whether Human Review feature should be skipped for this request. Default to
 false.
 

bool skip_human_review = 4;

Parameters:

value - The skipHumanReview to set.

Returns:

This builder for chaining.

clearSkipHumanReview

public BatchProcessRequest.Builder clearSkipHumanReview()

 Whether Human Review feature should be skipped for this request. Default to
 false.
 

bool skip_human_review = 4;

Returns:

This builder for chaining.

setUnknownFields

public final BatchProcessRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BatchProcessRequest.Builder>

mergeUnknownFields

public final BatchProcessRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BatchProcessRequest.Builder>