Class HumanReviewStatus

public final class HumanReviewStatus extends GeneratedMessageV3 implements HumanReviewStatusOrBuilder

The status of human review on a processed document.

Protobuf type google.cloud.documentai.v1beta3.HumanReviewStatus

Static Fields

HUMAN_REVIEW_OPERATION_FIELD_NUMBER

public static final int HUMAN_REVIEW_OPERATION_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_MESSAGE_FIELD_NUMBER

public static final int STATE_MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static HumanReviewStatus getDefaultInstance()
Returns
TypeDescription
HumanReviewStatus

getDescriptor()

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

newBuilder()

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

newBuilder(HumanReviewStatus prototype)

public static HumanReviewStatus.Builder newBuilder(HumanReviewStatus prototype)
Parameter
NameDescription
prototypeHumanReviewStatus
Returns
TypeDescription
HumanReviewStatus.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public HumanReviewStatus getDefaultInstanceForType()
Returns
TypeDescription
HumanReviewStatus

getHumanReviewOperation()

public String getHumanReviewOperation()

The name of the operation triggered by the processed document. This field is populated only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and metadata as the long running operation returned by [ReviewDocument] method.

string human_review_operation = 3;

Returns
TypeDescription
String

The humanReviewOperation.

getHumanReviewOperationBytes()

public ByteString getHumanReviewOperationBytes()

The name of the operation triggered by the processed document. This field is populated only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and metadata as the long running operation returned by [ReviewDocument] method.

string human_review_operation = 3;

Returns
TypeDescription
ByteString

The bytes for humanReviewOperation.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public HumanReviewStatus.State getState()

The state of human review on the processing request.

.google.cloud.documentai.v1beta3.HumanReviewStatus.State state = 1;

Returns
TypeDescription
HumanReviewStatus.State

The state.

getStateMessage()

public String getStateMessage()

A message providing more details about the human review state.

string state_message = 2;

Returns
TypeDescription
String

The stateMessage.

getStateMessageBytes()

public ByteString getStateMessageBytes()

A message providing more details about the human review state.

string state_message = 2;

Returns
TypeDescription
ByteString

The bytes for stateMessage.

getStateValue()

public int getStateValue()

The state of human review on the processing request.

.google.cloud.documentai.v1beta3.HumanReviewStatus.State state = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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 HumanReviewStatus.Builder newBuilderForType()
Returns
TypeDescription
HumanReviewStatus.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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