Package com.google.cloud.documentai.v1

Class CommonOperationMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1.CommonOperationMetadata

All Implemented Interfaces:

CommonOperationMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class CommonOperationMetadata
extends com.google.protobuf.GeneratedMessageV3
implements CommonOperationMetadataOrBuilder

 The common metadata for long running operations.
 

Protobuf type google.cloud.documentai.v1.CommonOperationMetadata

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommonOperationMetadata.Builder	The common metadata for long running operations.
static class	CommonOperationMetadata.State	State of the longrunning operation.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	CREATE_TIME_FIELD_NUMBER
static int	RESOURCE_FIELD_NUMBER
static int	STATE_FIELD_NUMBER
static int	STATE_MESSAGE_FIELD_NUMBER
static int	UPDATE_TIME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
com.google.protobuf.Timestamp	getCreateTime()	The creation time of the operation.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder()	The creation time of the operation.
static CommonOperationMetadata	getDefaultInstance()
CommonOperationMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<CommonOperationMetadata>	getParserForType()
String	getResource()	A related resource to this operation.
com.google.protobuf.ByteString	getResourceBytes()	A related resource to this operation.
int	getSerializedSize()
CommonOperationMetadata.State	getState()	The state of the operation.
String	getStateMessage()	A message providing more details about the current state of processing.
com.google.protobuf.ByteString	getStateMessageBytes()	A message providing more details about the current state of processing.
int	getStateValue()	The state of the operation.
com.google.protobuf.Timestamp	getUpdateTime()	The last update time of the operation.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder()	The last update time of the operation.
boolean	hasCreateTime()	The creation time of the operation.
int	hashCode()
boolean	hasUpdateTime()	The last update time of the operation.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static CommonOperationMetadata.Builder	newBuilder()
static CommonOperationMetadata.Builder	newBuilder(CommonOperationMetadata prototype)
CommonOperationMetadata.Builder	newBuilderForType()
protected CommonOperationMetadata.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CommonOperationMetadata	parseDelimitedFrom(InputStream input)
static CommonOperationMetadata	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CommonOperationMetadata	parseFrom(byte[] data)
static CommonOperationMetadata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CommonOperationMetadata	parseFrom(com.google.protobuf.ByteString data)
static CommonOperationMetadata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CommonOperationMetadata	parseFrom(com.google.protobuf.CodedInputStream input)
static CommonOperationMetadata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CommonOperationMetadata	parseFrom(InputStream input)
static CommonOperationMetadata	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CommonOperationMetadata	parseFrom(ByteBuffer data)
static CommonOperationMetadata	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CommonOperationMetadata>	parser()
CommonOperationMetadata.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Detail

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

See Also:

Constant Field Values

STATE_MESSAGE_FIELD_NUMBER

public static final int STATE_MESSAGE_FIELD_NUMBER

See Also:

Constant Field Values

RESOURCE_FIELD_NUMBER

public static final int RESOURCE_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getStateValue

public int getStateValue()

 The state of the operation.
 

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

Specified by:

getStateValue in interface CommonOperationMetadataOrBuilder

Returns:

The enum numeric value on the wire for state.

getState

public CommonOperationMetadata.State getState()

 The state of the operation.
 

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

Specified by:

getState in interface CommonOperationMetadataOrBuilder

Returns:

The state.

getStateMessage

public String getStateMessage()

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

string state_message = 2;

Specified by:

getStateMessage in interface CommonOperationMetadataOrBuilder

Returns:

The stateMessage.

getStateMessageBytes

public com.google.protobuf.ByteString getStateMessageBytes()

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

string state_message = 2;

Specified by:

getStateMessageBytes in interface CommonOperationMetadataOrBuilder

Returns:

The bytes for stateMessage.

getResource

public String getResource()

 A related resource to this operation.
 

string resource = 5;

Specified by:

getResource in interface CommonOperationMetadataOrBuilder

Returns:

The resource.

getResourceBytes

public com.google.protobuf.ByteString getResourceBytes()

 A related resource to this operation.
 

string resource = 5;

Specified by:

getResourceBytes in interface CommonOperationMetadataOrBuilder

Returns:

The bytes for resource.

hasCreateTime

public boolean hasCreateTime()

 The creation time of the operation.
 

.google.protobuf.Timestamp create_time = 3;

Specified by:

hasCreateTime in interface CommonOperationMetadataOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 The creation time of the operation.
 

.google.protobuf.Timestamp create_time = 3;

Specified by:

getCreateTime in interface CommonOperationMetadataOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 The creation time of the operation.
 

.google.protobuf.Timestamp create_time = 3;

Specified by:

getCreateTimeOrBuilder in interface CommonOperationMetadataOrBuilder

hasUpdateTime

public boolean hasUpdateTime()

 The last update time of the operation.
 

.google.protobuf.Timestamp update_time = 4;

Specified by:

hasUpdateTime in interface CommonOperationMetadataOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime

public com.google.protobuf.Timestamp getUpdateTime()

 The last update time of the operation.
 

.google.protobuf.Timestamp update_time = 4;

Specified by:

getUpdateTime in interface CommonOperationMetadataOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 The last update time of the operation.
 

.google.protobuf.Timestamp update_time = 4;

Specified by:

getUpdateTimeOrBuilder in interface CommonOperationMetadataOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static CommonOperationMetadata parseFrom(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CommonOperationMetadata parseFrom(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CommonOperationMetadata parseFrom(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CommonOperationMetadata parseFrom(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CommonOperationMetadata parseFrom(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CommonOperationMetadata parseFrom(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CommonOperationMetadata parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static CommonOperationMetadata parseFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static CommonOperationMetadata parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static CommonOperationMetadata parseDelimitedFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseFrom

public static CommonOperationMetadata parseFrom(com.google.protobuf.CodedInputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static CommonOperationMetadata parseFrom(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

newBuilderForType

public CommonOperationMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CommonOperationMetadata.Builder newBuilder()

newBuilder

public static CommonOperationMetadata.Builder newBuilder(CommonOperationMetadata prototype)

toBuilder

public CommonOperationMetadata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected CommonOperationMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static CommonOperationMetadata getDefaultInstance()

parser

public static com.google.protobuf.Parser<CommonOperationMetadata> parser()

getParserForType

public com.google.protobuf.Parser<CommonOperationMetadata> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public CommonOperationMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder