Class ReviewDocumentRequest (2.49.0)

public final class ReviewDocumentRequest extends GeneratedMessageV3 implements ReviewDocumentRequestOrBuilder

Request message for the ReviewDocument method.

Protobuf type google.cloud.documentai.v1beta3.ReviewDocumentRequest

Static Fields

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENT_SCHEMA_FIELD_NUMBER

public static final int DOCUMENT_SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_SCHEMA_VALIDATION_FIELD_NUMBER

public static final int ENABLE_SCHEMA_VALIDATION_FIELD_NUMBER
Field Value
Type Description
int

HUMAN_REVIEW_CONFIG_FIELD_NUMBER

public static final int HUMAN_REVIEW_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

INLINE_DOCUMENT_FIELD_NUMBER

public static final int INLINE_DOCUMENT_FIELD_NUMBER
Field Value
Type Description
int

PRIORITY_FIELD_NUMBER

public static final int PRIORITY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ReviewDocumentRequest getDefaultInstance()
Returns
Type Description
ReviewDocumentRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ReviewDocumentRequest.Builder newBuilder()
Returns
Type Description
ReviewDocumentRequest.Builder

newBuilder(ReviewDocumentRequest prototype)

public static ReviewDocumentRequest.Builder newBuilder(ReviewDocumentRequest prototype)
Parameter
Name Description
prototype ReviewDocumentRequest
Returns
Type Description
ReviewDocumentRequest.Builder

parseDelimitedFrom(InputStream input)

public static ReviewDocumentRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReviewDocumentRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReviewDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReviewDocumentRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ReviewDocumentRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ReviewDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReviewDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReviewDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReviewDocumentRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ReviewDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReviewDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReviewDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReviewDocumentRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ReviewDocumentRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReviewDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReviewDocumentRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ReviewDocumentRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReviewDocumentRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReviewDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReviewDocumentRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ReviewDocumentRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ReviewDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReviewDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReviewDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ReviewDocumentRequest> parser()
Returns
Type Description
Parser<ReviewDocumentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ReviewDocumentRequest getDefaultInstanceForType()
Returns
Type Description
ReviewDocumentRequest

getDocument() (deprecated)

public Document getDocument()

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

The document that needs human review.

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

Returns
Type Description
Document

The document.

getDocumentOrBuilder() (deprecated)

public DocumentOrBuilder getDocumentOrBuilder()

The document that needs human review.

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

Returns
Type Description
DocumentOrBuilder

getDocumentSchema()

public DocumentSchema getDocumentSchema()

The document schema of the human review task.

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

Returns
Type Description
DocumentSchema

The documentSchema.

getDocumentSchemaOrBuilder()

public DocumentSchemaOrBuilder getDocumentSchemaOrBuilder()

The document schema of the human review task.

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

Returns
Type Description
DocumentSchemaOrBuilder

getEnableSchemaValidation()

public boolean getEnableSchemaValidation()

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

bool enable_schema_validation = 3;

Returns
Type Description
boolean

The enableSchemaValidation.

getHumanReviewConfig()

public String getHumanReviewConfig()

Required. The resource name of the HumanReviewConfig that the document will be reviewed with.

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

Returns
Type Description
String

The humanReviewConfig.

getHumanReviewConfigBytes()

public ByteString getHumanReviewConfigBytes()

Required. The resource name of the HumanReviewConfig that the document will be reviewed with.

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

Returns
Type Description
ByteString

The bytes for humanReviewConfig.

getInlineDocument()

public Document getInlineDocument()

An inline document proto.

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

Returns
Type Description
Document

The inlineDocument.

getInlineDocumentOrBuilder()

public DocumentOrBuilder getInlineDocumentOrBuilder()

An inline document proto.

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

Returns
Type Description
DocumentOrBuilder

getParserForType()

public Parser<ReviewDocumentRequest> getParserForType()
Returns
Type Description
Parser<ReviewDocumentRequest>
Overrides

getPriority()

public ReviewDocumentRequest.Priority getPriority()

The priority of the human review task.

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

Returns
Type Description
ReviewDocumentRequest.Priority

The priority.

getPriorityValue()

public int getPriorityValue()

The priority of the human review task.

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

Returns
Type Description
int

The enum numeric value on the wire for priority.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceCase()

public ReviewDocumentRequest.SourceCase getSourceCase()
Returns
Type Description
ReviewDocumentRequest.SourceCase

hasDocument() (deprecated)

public boolean hasDocument()

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

The document that needs human review.

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

Returns
Type Description
boolean

Whether the document field is set.

hasDocumentSchema()

public boolean hasDocumentSchema()

The document schema of the human review task.

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

Returns
Type Description
boolean

Whether the documentSchema field is set.

hasInlineDocument()

public boolean hasInlineDocument()

An inline document proto.

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

Returns
Type Description
boolean

Whether the inlineDocument field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ReviewDocumentRequest.Builder newBuilderForType()
Returns
Type Description
ReviewDocumentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReviewDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ReviewDocumentRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ReviewDocumentRequest.Builder toBuilder()
Returns
Type Description
ReviewDocumentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException