com.google.cloud.documentai.v1

Class BatchProcessRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1.BatchProcessRequest

All Implemented Interfaces:

BatchProcessRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class BatchProcessRequest
extends com.google.protobuf.GeneratedMessageV3
implements BatchProcessRequestOrBuilder

 Request message for batch process document method.
 

Protobuf type google.cloud.documentai.v1.BatchProcessRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchProcessRequest.Builder Request message for batch process document method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER
static int	INPUT_DOCUMENTS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	SKIP_HUMAN_REVIEW_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static BatchProcessRequest	getDefaultInstance()
BatchProcessRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
DocumentOutputConfig	getDocumentOutputConfig() The overall output config for batch process.
DocumentOutputConfigOrBuilder	getDocumentOutputConfigOrBuilder() The overall output config for batch process.
BatchDocumentsInputConfig	getInputDocuments() The input documents for batch process.
BatchDocumentsInputConfigOrBuilder	getInputDocumentsOrBuilder() The input documents for batch process.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
com.google.protobuf.Parser<BatchProcessRequest>	getParserForType()
int	getSerializedSize()
boolean	getSkipHumanReview() Whether Human Review feature should be skipped for this request.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasDocumentOutputConfig() The overall output config for batch process.
int	hashCode()
boolean	hasInputDocuments() The input documents for batch process.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static BatchProcessRequest.Builder	newBuilder()
static BatchProcessRequest.Builder	newBuilder(BatchProcessRequest prototype)
BatchProcessRequest.Builder	newBuilderForType()
protected BatchProcessRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static BatchProcessRequest	parseDelimitedFrom(InputStream input)
static BatchProcessRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchProcessRequest	parseFrom(byte[] data)
static BatchProcessRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchProcessRequest	parseFrom(ByteBuffer data)
static BatchProcessRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchProcessRequest	parseFrom(com.google.protobuf.ByteString data)
static BatchProcessRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchProcessRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static BatchProcessRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchProcessRequest	parseFrom(InputStream input)
static BatchProcessRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BatchProcessRequest>	parser()
BatchProcessRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

INPUT_DOCUMENTS_FIELD_NUMBER

public static final int INPUT_DOCUMENTS_FIELD_NUMBER

See Also:

Constant Field Values

DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER

public static final int DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

SKIP_HUMAN_REVIEW_FIELD_NUMBER

public static final int SKIP_HUMAN_REVIEW_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

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.

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.

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static BatchProcessRequest parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchProcessRequest parseFrom(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchProcessRequest parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchProcessRequest parseFrom(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchProcessRequest parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchProcessRequest parseFrom(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchProcessRequest parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static BatchProcessRequest parseFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static BatchProcessRequest parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static BatchProcessRequest parseDelimitedFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseFrom

public static BatchProcessRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static BatchProcessRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

newBuilderForType

public BatchProcessRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static BatchProcessRequest.Builder newBuilder()

newBuilder

public static BatchProcessRequest.Builder newBuilder(BatchProcessRequest prototype)

toBuilder

public BatchProcessRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected BatchProcessRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static BatchProcessRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<BatchProcessRequest> parser()

getParserForType

public com.google.protobuf.Parser<BatchProcessRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public BatchProcessRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder