Class CommonOperationMetadata (2.46.0)

public final class CommonOperationMetadata extends GeneratedMessageV3 implements CommonOperationMetadataOrBuilder

The common metadata for long running operations.

Protobuf type google.cloud.documentai.v1.CommonOperationMetadata

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_FIELD_NUMBER

public static final int RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

STATE_MESSAGE_FIELD_NUMBER

public static final int STATE_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CommonOperationMetadata getDefaultInstance()
Returns
Type Description
CommonOperationMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(CommonOperationMetadata prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCreateTime()

public Timestamp getCreateTime()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public CommonOperationMetadata getDefaultInstanceForType()
Returns
Type Description
CommonOperationMetadata

getParserForType()

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

getResource()

public String getResource()

A related resource to this operation.

string resource = 5;

Returns
Type Description
String

The resource.

getResourceBytes()

public ByteString getResourceBytes()

A related resource to this operation.

string resource = 5;

Returns
Type Description
ByteString

The bytes for resource.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public CommonOperationMetadata.State getState()

The state of the operation.

.google.cloud.documentai.v1.CommonOperationMetadata.State state = 1;

Returns
Type Description
CommonOperationMetadata.State

The state.

getStateMessage()

public String getStateMessage()

A message providing more details about the current state of processing.

string state_message = 2;

Returns
Type Description
String

The stateMessage.

getStateMessageBytes()

public ByteString getStateMessageBytes()

A message providing more details about the current state of processing.

string state_message = 2;

Returns
Type Description
ByteString

The bytes for stateMessage.

getStateValue()

public int getStateValue()

The state of the operation.

.google.cloud.documentai.v1.CommonOperationMetadata.State state = 1;

Returns
Type Description
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
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
Type Description
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
Type Description
boolean

Whether the updateTime 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 CommonOperationMetadata.Builder newBuilderForType()
Returns
Type Description
CommonOperationMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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