Class ReviewDocumentOperationMetadata (2.41.0)

public final class ReviewDocumentOperationMetadata extends GeneratedMessageV3 implements ReviewDocumentOperationMetadataOrBuilder

The long-running operation metadata for the ReviewDocument method.

Protobuf type google.cloud.documentai.v1beta3.ReviewDocumentOperationMetadata

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ReviewDocumentOperationMetadata

Static Fields

COMMON_METADATA_FIELD_NUMBER

public static final int COMMON_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

QUESTION_ID_FIELD_NUMBER

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

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ReviewDocumentOperationMetadata getDefaultInstance()
Returns
TypeDescription
ReviewDocumentOperationMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(ReviewDocumentOperationMetadata prototype)

public static ReviewDocumentOperationMetadata.Builder newBuilder(ReviewDocumentOperationMetadata prototype)
Parameter
NameDescription
prototypeReviewDocumentOperationMetadata
Returns
TypeDescription
ReviewDocumentOperationMetadata.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCommonMetadata()

public CommonOperationMetadata getCommonMetadata()

The basic metadata of the long-running operation.

.google.cloud.documentai.v1beta3.CommonOperationMetadata common_metadata = 5;

Returns
TypeDescription
CommonOperationMetadata

The commonMetadata.

getCommonMetadataOrBuilder()

public CommonOperationMetadataOrBuilder getCommonMetadataOrBuilder()

The basic metadata of the long-running operation.

.google.cloud.documentai.v1beta3.CommonOperationMetadata common_metadata = 5;

Returns
TypeDescription
CommonOperationMetadataOrBuilder

getCreateTime()

public Timestamp getCreateTime()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public ReviewDocumentOperationMetadata getDefaultInstanceForType()
Returns
TypeDescription
ReviewDocumentOperationMetadata

getParserForType()

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

getQuestionId()

public String getQuestionId()

The Crowd Compute question ID.

string question_id = 6;

Returns
TypeDescription
String

The questionId.

getQuestionIdBytes()

public ByteString getQuestionIdBytes()

The Crowd Compute question ID.

string question_id = 6;

Returns
TypeDescription
ByteString

The bytes for questionId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public ReviewDocumentOperationMetadata.State getState()

Used only when Operation.done is false.

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

Returns
TypeDescription
ReviewDocumentOperationMetadata.State

The state.

getStateMessage()

public String getStateMessage()

A message providing more details about the current state of processing. For example, the error message if the operation is failed.

string state_message = 2;

Returns
TypeDescription
String

The stateMessage.

getStateMessageBytes()

public ByteString getStateMessageBytes()

A message providing more details about the current state of processing. For example, the error message if the operation is failed.

string state_message = 2;

Returns
TypeDescription
ByteString

The bytes for stateMessage.

getStateValue()

public int getStateValue()

Used only when Operation.done is false.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Returns
TypeDescription
TimestampOrBuilder

hasCommonMetadata()

public boolean hasCommonMetadata()

The basic metadata of the long-running operation.

.google.cloud.documentai.v1beta3.CommonOperationMetadata common_metadata = 5;

Returns
TypeDescription
boolean

Whether the commonMetadata field is set.

hasCreateTime()

public boolean hasCreateTime()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Returns
TypeDescription
boolean

Whether the updateTime 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 ReviewDocumentOperationMetadata.Builder newBuilderForType()
Returns
TypeDescription
ReviewDocumentOperationMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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