Class ReviewDocumentRequest (2.8.0)

public final class ReviewDocumentRequest extends GeneratedMessageV3 implements ReviewDocumentRequestOrBuilder

Request message for review document method.

Protobuf type google.cloud.documentai.v1beta3.ReviewDocumentRequest

Static Fields

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENT_SCHEMA_FIELD_NUMBER

public static final int DOCUMENT_SCHEMA_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLE_SCHEMA_VALIDATION_FIELD_NUMBER

public static final int ENABLE_SCHEMA_VALIDATION_FIELD_NUMBER
Field Value
TypeDescription
int

HUMAN_REVIEW_CONFIG_FIELD_NUMBER

public static final int HUMAN_REVIEW_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

INLINE_DOCUMENT_FIELD_NUMBER

public static final int INLINE_DOCUMENT_FIELD_NUMBER
Field Value
TypeDescription
int

PRIORITY_FIELD_NUMBER

public static final int PRIORITY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ReviewDocumentRequest getDefaultInstance()
Returns
TypeDescription
ReviewDocumentRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ReviewDocumentRequest.Builder newBuilder()
Returns
TypeDescription
ReviewDocumentRequest.Builder

newBuilder(ReviewDocumentRequest prototype)

public static ReviewDocumentRequest.Builder newBuilder(ReviewDocumentRequest prototype)
Parameter
NameDescription
prototypeReviewDocumentRequest
Returns
TypeDescription
ReviewDocumentRequest.Builder

parseDelimitedFrom(InputStream input)

public static ReviewDocumentRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReviewDocumentRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReviewDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReviewDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ReviewDocumentRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ReviewDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReviewDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReviewDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReviewDocumentRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ReviewDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReviewDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReviewDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReviewDocumentRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ReviewDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReviewDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReviewDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ReviewDocumentRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReviewDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReviewDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReviewDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ReviewDocumentRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ReviewDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReviewDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReviewDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ReviewDocumentRequest> parser()
Returns
TypeDescription
Parser<ReviewDocumentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ReviewDocumentRequest getDefaultInstanceForType()
Returns
TypeDescription
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=799

The document that needs human review.

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

Returns
TypeDescription
Document

The document.

getDocumentOrBuilder()

public DocumentOrBuilder getDocumentOrBuilder()

The document that needs human review.

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

Returns
TypeDescription
DocumentOrBuilder

getDocumentSchema()

public DocumentSchema getDocumentSchema()

The document schema of the human review task.

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

Returns
TypeDescription
DocumentSchema

The documentSchema.

getDocumentSchemaOrBuilder()

public DocumentSchemaOrBuilder getDocumentSchemaOrBuilder()

The document schema of the human review task.

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

Returns
TypeDescription
DocumentSchemaOrBuilder

getEnableSchemaValidation()

public boolean getEnableSchemaValidation()

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

bool enable_schema_validation = 3;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for humanReviewConfig.

getInlineDocument()

public Document getInlineDocument()

An inline document proto.

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

Returns
TypeDescription
Document

The inlineDocument.

getInlineDocumentOrBuilder()

public DocumentOrBuilder getInlineDocumentOrBuilder()

An inline document proto.

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

Returns
TypeDescription
DocumentOrBuilder

getParserForType()

public Parser<ReviewDocumentRequest> getParserForType()
Returns
TypeDescription
Parser<ReviewDocumentRequest>
Overrides

getPriority()

public ReviewDocumentRequest.Priority getPriority()

The priority of the human review task.

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

Returns
TypeDescription
ReviewDocumentRequest.Priority

The priority.

getPriorityValue()

public int getPriorityValue()

The priority of the human review task.

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

Returns
TypeDescription
int

The enum numeric value on the wire for priority.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceCase()

public ReviewDocumentRequest.SourceCase getSourceCase()
Returns
TypeDescription
ReviewDocumentRequest.SourceCase

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasDocument() (deprecated)

public boolean hasDocument()

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

The document that needs human review.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the documentSchema field is set.

hasInlineDocument()

public boolean hasInlineDocument()

An inline document proto.

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

Returns
TypeDescription
boolean

Whether the inlineDocument field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ReviewDocumentRequest.Builder newBuilderForType()
Returns
TypeDescription
ReviewDocumentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReviewDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ReviewDocumentRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ReviewDocumentRequest.Builder toBuilder()
Returns
TypeDescription
ReviewDocumentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException