Package com.google.cloud.documentai.v1beta3

Class ReviewDocumentRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1beta3.ReviewDocumentRequest

All Implemented Interfaces:

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

public final class ReviewDocumentRequest
extends com.google.protobuf.GeneratedMessageV3
implements ReviewDocumentRequestOrBuilder

 Request message for the
 [ReviewDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ReviewDocument]
 method.
 

Protobuf type google.cloud.documentai.v1beta3.ReviewDocumentRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReviewDocumentRequest.Builder	Request message for the [ReviewDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ReviewDocument] method.
static class	ReviewDocumentRequest.Priority	The priority level of the human review task.
static class	ReviewDocumentRequest.SourceCase

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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	Description
static int	DOCUMENT_FIELD_NUMBER
static int	DOCUMENT_SCHEMA_FIELD_NUMBER
static int	ENABLE_SCHEMA_VALIDATION_FIELD_NUMBER
static int	HUMAN_REVIEW_CONFIG_FIELD_NUMBER
static int	INLINE_DOCUMENT_FIELD_NUMBER
static int	PRIORITY_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	Description
boolean	equals(Object obj)
static ReviewDocumentRequest	getDefaultInstance()
ReviewDocumentRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Document	getDocument()	Deprecated. google.cloud.documentai.v1beta3.ReviewDocumentRequest.document is deprecated.
DocumentOrBuilder	getDocumentOrBuilder()	Deprecated.
DocumentSchema	getDocumentSchema()	The document schema of the human review task.
DocumentSchemaOrBuilder	getDocumentSchemaOrBuilder()	The document schema of the human review task.
boolean	getEnableSchemaValidation()	Whether the validation should be performed on the ad-hoc review request.
String	getHumanReviewConfig()	Required.
com.google.protobuf.ByteString	getHumanReviewConfigBytes()	Required.
Document	getInlineDocument()	An inline document proto.
DocumentOrBuilder	getInlineDocumentOrBuilder()	An inline document proto.
com.google.protobuf.Parser<ReviewDocumentRequest>	getParserForType()
ReviewDocumentRequest.Priority	getPriority()	The priority of the human review task.
int	getPriorityValue()	The priority of the human review task.
int	getSerializedSize()
ReviewDocumentRequest.SourceCase	getSourceCase()
boolean	hasDocument()	Deprecated. google.cloud.documentai.v1beta3.ReviewDocumentRequest.document is deprecated.
boolean	hasDocumentSchema()	The document schema of the human review task.
int	hashCode()
boolean	hasInlineDocument()	An inline document proto.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ReviewDocumentRequest.Builder	newBuilder()
static ReviewDocumentRequest.Builder	newBuilder(ReviewDocumentRequest prototype)
ReviewDocumentRequest.Builder	newBuilderForType()
protected ReviewDocumentRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ReviewDocumentRequest	parseDelimitedFrom(InputStream input)
static ReviewDocumentRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReviewDocumentRequest	parseFrom(byte[] data)
static ReviewDocumentRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReviewDocumentRequest	parseFrom(com.google.protobuf.ByteString data)
static ReviewDocumentRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReviewDocumentRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ReviewDocumentRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReviewDocumentRequest	parseFrom(InputStream input)
static ReviewDocumentRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReviewDocumentRequest	parseFrom(ByteBuffer data)
static ReviewDocumentRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ReviewDocumentRequest>	parser()
ReviewDocumentRequest.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, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

INLINE_DOCUMENT_FIELD_NUMBER

public static final int INLINE_DOCUMENT_FIELD_NUMBER

See Also:

Constant Field Values

HUMAN_REVIEW_CONFIG_FIELD_NUMBER

public static final int HUMAN_REVIEW_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER

See Also:

Constant Field Values

ENABLE_SCHEMA_VALIDATION_FIELD_NUMBER

public static final int ENABLE_SCHEMA_VALIDATION_FIELD_NUMBER

See Also:

Constant Field Values

PRIORITY_FIELD_NUMBER

public static final int PRIORITY_FIELD_NUMBER

See Also:

Constant Field Values

DOCUMENT_SCHEMA_FIELD_NUMBER

public static final int DOCUMENT_SCHEMA_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

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

getSourceCase

public ReviewDocumentRequest.SourceCase getSourceCase()

Specified by:

getSourceCase in interface ReviewDocumentRequestOrBuilder

hasInlineDocument

public boolean hasInlineDocument()

 An inline document proto.
 

.google.cloud.documentai.v1beta3.Document inline_document = 4;

Specified by:

hasInlineDocument in interface ReviewDocumentRequestOrBuilder

Returns:

Whether the inlineDocument field is set.

getInlineDocument

public Document getInlineDocument()

 An inline document proto.
 

.google.cloud.documentai.v1beta3.Document inline_document = 4;

Specified by:

getInlineDocument in interface ReviewDocumentRequestOrBuilder

Returns:

The inlineDocument.

getInlineDocumentOrBuilder

public DocumentOrBuilder getInlineDocumentOrBuilder()

 An inline document proto.
 

.google.cloud.documentai.v1beta3.Document inline_document = 4;

Specified by:

getInlineDocumentOrBuilder in interface ReviewDocumentRequestOrBuilder

getHumanReviewConfig

public String getHumanReviewConfig()

 Required. The resource name of the
 [HumanReviewConfig][google.cloud.documentai.v1beta3.HumanReviewConfig] that
 the document will be reviewed with.
 

string human_review_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getHumanReviewConfig in interface ReviewDocumentRequestOrBuilder

Returns:

The humanReviewConfig.

getHumanReviewConfigBytes

public com.google.protobuf.ByteString getHumanReviewConfigBytes()

 Required. The resource name of the
 [HumanReviewConfig][google.cloud.documentai.v1beta3.HumanReviewConfig] that
 the document will be reviewed with.
 

string human_review_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getHumanReviewConfigBytes in interface ReviewDocumentRequestOrBuilder

Returns:

The bytes for humanReviewConfig.

hasDocument

@Deprecated
public boolean hasDocument()

Deprecated.

google.cloud.documentai.v1beta3.ReviewDocumentRequest.document is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=1099

 The document that needs human review.
 

.google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];

Specified by:

hasDocument in interface ReviewDocumentRequestOrBuilder

Returns:

Whether the document field is set.

getDocument

@Deprecated
public Document getDocument()

Deprecated.

google.cloud.documentai.v1beta3.ReviewDocumentRequest.document is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=1099

 The document that needs human review.
 

.google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];

Specified by:

getDocument in interface ReviewDocumentRequestOrBuilder

Returns:

The document.

getDocumentOrBuilder

@Deprecated
public DocumentOrBuilder getDocumentOrBuilder()

Deprecated.

 The document that needs human review.
 

.google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];

Specified by:

getDocumentOrBuilder in interface ReviewDocumentRequestOrBuilder

getEnableSchemaValidation

public boolean getEnableSchemaValidation()

 Whether the validation should be performed on the ad-hoc review request.
 

bool enable_schema_validation = 3;

Specified by:

getEnableSchemaValidation in interface ReviewDocumentRequestOrBuilder

Returns:

The enableSchemaValidation.

getPriorityValue

public int getPriorityValue()

 The priority of the human review task.
 

.google.cloud.documentai.v1beta3.ReviewDocumentRequest.Priority priority = 5;

Specified by:

getPriorityValue in interface ReviewDocumentRequestOrBuilder

Returns:

The enum numeric value on the wire for priority.

getPriority

public ReviewDocumentRequest.Priority getPriority()

 The priority of the human review task.
 

.google.cloud.documentai.v1beta3.ReviewDocumentRequest.Priority priority = 5;

Specified by:

getPriority in interface ReviewDocumentRequestOrBuilder

Returns:

The priority.

hasDocumentSchema

public boolean hasDocumentSchema()

 The document schema of the human review task.
 

.google.cloud.documentai.v1beta3.DocumentSchema document_schema = 6;

Specified by:

hasDocumentSchema in interface ReviewDocumentRequestOrBuilder

Returns:

Whether the documentSchema field is set.

getDocumentSchema

public DocumentSchema getDocumentSchema()

 The document schema of the human review task.
 

.google.cloud.documentai.v1beta3.DocumentSchema document_schema = 6;

Specified by:

getDocumentSchema in interface ReviewDocumentRequestOrBuilder

Returns:

The documentSchema.

getDocumentSchemaOrBuilder

public DocumentSchemaOrBuilder getDocumentSchemaOrBuilder()

 The document schema of the human review task.
 

.google.cloud.documentai.v1beta3.DocumentSchema document_schema = 6;

Specified by:

getDocumentSchemaOrBuilder in interface ReviewDocumentRequestOrBuilder

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 ReviewDocumentRequest parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReviewDocumentRequest parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ReviewDocumentRequest parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ReviewDocumentRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ReviewDocumentRequest.Builder newBuilder()

newBuilder

public static ReviewDocumentRequest.Builder newBuilder(ReviewDocumentRequest prototype)

toBuilder

public ReviewDocumentRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ReviewDocumentRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<ReviewDocumentRequest> 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 ReviewDocumentRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder