Class CommonOperationMetadata (2.80.0)
Version 2.80.0keyboard_arrow_down
public final class CommonOperationMetadata extends GeneratedMessageV3 implements CommonOperationMetadataOrBuilder
The common metadata for long running operations.
Protobuf type google.cloud.documentai.v1.CommonOperationMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
public static final int RESOURCE_FIELD_NUMBER
Field Value
Type Description
int
public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int
public static final int STATE_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static CommonOperationMetadata getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static CommonOperationMetadata . Builder newBuilder ()
public static CommonOperationMetadata . Builder newBuilder ( CommonOperationMetadata prototype )
public static CommonOperationMetadata parseDelimitedFrom ( InputStream input )
public static CommonOperationMetadata parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static CommonOperationMetadata parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static CommonOperationMetadata parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static CommonOperationMetadata parseFrom ( ByteString data )
public static CommonOperationMetadata parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static CommonOperationMetadata parseFrom ( CodedInputStream input )
public static CommonOperationMetadata parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static CommonOperationMetadata parseFrom ( InputStream input )
public static CommonOperationMetadata parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static CommonOperationMetadata parseFrom ( ByteBuffer data )
public static CommonOperationMetadata parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<CommonOperationMetadata> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public Timestamp getCreateTime ()
The creation time of the operation.
.google.protobuf.Timestamp create_time = 3;
Returns
Type Description
Timestamp The createTime.
public TimestampOrBuilder getCreateTimeOrBuilder ()
The creation time of the operation.
.google.protobuf.Timestamp create_time = 3;
public CommonOperationMetadata getDefaultInstanceForType ()
public Parser<CommonOperationMetadata> getParserForType ()
Overrides
public String getResource ()
A related resource to this operation.
string resource = 5;
Returns
Type Description
String The resource.
public ByteString getResourceBytes ()
A related resource to this operation.
string resource = 5;
Returns
Type Description
ByteString The bytes for resource.
public int getSerializedSize ()
Returns
Type Description
int
Overrides
public CommonOperationMetadata . State getState ()
The state of the operation.
.google.cloud.documentai.v1.CommonOperationMetadata.State state = 1;
public String getStateMessage ()
A message providing more details about the current state of processing.
string state_message = 2;
Returns
Type Description
String The stateMessage.
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.
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.
public Timestamp getUpdateTime ()
The last update time of the operation.
.google.protobuf.Timestamp update_time = 4;
Returns
Type Description
Timestamp The updateTime.
public TimestampOrBuilder getUpdateTimeOrBuilder ()
The last update time of the operation.
.google.protobuf.Timestamp update_time = 4;
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.
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.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public CommonOperationMetadata . Builder newBuilderForType ()
protected CommonOperationMetadata . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public CommonOperationMetadata . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
