Class OperationMetadata (2.8.0)

Version 2.8.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.4
• 2.4.3
• 2.3.6

public final class OperationMetadata extends GeneratedMessageV3 implements OperationMetadataOrBuilder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.functions.v2alpha.OperationMetadata

Inheritance

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

Implements

OperationMetadataOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

API_VERSION_FIELD_NUMBER

public static final int API_VERSION_FIELD_NUMBER

Field Value

Type	Description
int

CANCEL_REQUESTED_FIELD_NUMBER

public static final int CANCEL_REQUESTED_FIELD_NUMBER

Field Value

Type	Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value

Type	Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

Field Value

Type	Description
int

REQUEST_RESOURCE_FIELD_NUMBER

public static final int REQUEST_RESOURCE_FIELD_NUMBER

Field Value

Type	Description
int

STAGES_FIELD_NUMBER

public static final int STAGES_FIELD_NUMBER

Field Value

Type	Description
int

STATUS_DETAIL_FIELD_NUMBER

public static final int STATUS_DETAIL_FIELD_NUMBER

Field Value

Type	Description
int

TARGET_FIELD_NUMBER

public static final int TARGET_FIELD_NUMBER

Field Value

Type	Description
int

VERB_FIELD_NUMBER

public static final int VERB_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static OperationMetadata getDefaultInstance()

Returns

Type	Description
OperationMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static OperationMetadata.Builder newBuilder()

Returns

Type	Description
OperationMetadata.Builder

newBuilder(OperationMetadata prototype)

public static OperationMetadata.Builder newBuilder(OperationMetadata prototype)

Parameter

Name	Description
prototype	OperationMetadata

Returns

Type	Description
OperationMetadata.Builder

parseDelimitedFrom(InputStream input)

public static OperationMetadata parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
OperationMetadata

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
OperationMetadata

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static OperationMetadata parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
OperationMetadata

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
OperationMetadata

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OperationMetadata parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
OperationMetadata

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
OperationMetadata

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OperationMetadata parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
OperationMetadata

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
OperationMetadata

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static OperationMetadata parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
OperationMetadata

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
OperationMetadata

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static OperationMetadata parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
OperationMetadata

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
OperationMetadata

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<OperationMetadata> parser()

Returns

Type	Description
Parser<OperationMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getApiVersion()

public String getApiVersion()

API version used to start the operation.

string api_version = 7;

Returns

Type	Description
String	The apiVersion.

getApiVersionBytes()

public ByteString getApiVersionBytes()

API version used to start the operation.

string api_version = 7;

Returns

Type	Description
ByteString	The bytes for apiVersion.

getCancelRequested()

public boolean getCancelRequested()

Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

bool cancel_requested = 6;

Returns

Type	Description
boolean	The cancelRequested.

getCreateTime()

public Timestamp getCreateTime()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns

Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public OperationMetadata getDefaultInstanceForType()

Returns

Type	Description
OperationMetadata

getEndTime()

public Timestamp getEndTime()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns

Type	Description
Timestamp	The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns

Type	Description
TimestampOrBuilder

getParserForType()

public Parser<OperationMetadata> getParserForType()

Returns

Type	Description
Parser<OperationMetadata>

Overrides

GeneratedMessageV3.getParserForType()

getRequestResource()

public Any getRequestResource()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns

Type	Description
Any	The requestResource.

getRequestResourceOrBuilder()

public AnyOrBuilder getRequestResourceOrBuilder()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns

Type	Description
AnyOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getStages(int index)

public Stage getStages(int index)

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Parameter

Name	Description
index	int

Returns

Type	Description
Stage

getStagesCount()

public int getStagesCount()

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Returns

Type	Description
int

getStagesList()

public List<Stage> getStagesList()

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Returns

Type	Description
List<Stage>

getStagesOrBuilder(int index)

public StageOrBuilder getStagesOrBuilder(int index)

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Parameter

Name	Description
index	int

Returns

Type	Description
StageOrBuilder

getStagesOrBuilderList()

public List<? extends StageOrBuilder> getStagesOrBuilderList()

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Returns

Type	Description
List<? extends com.google.cloud.functions.v2alpha.StageOrBuilder>

getStatusDetail()

public String getStatusDetail()

Human-readable status of the operation, if any.

string status_detail = 5;

Returns

Type	Description
String	The statusDetail.

getStatusDetailBytes()

public ByteString getStatusDetailBytes()

Human-readable status of the operation, if any.

string status_detail = 5;

Returns

Type	Description
ByteString	The bytes for statusDetail.

getTarget()

public String getTarget()

Server-defined resource path for the target of the operation.

string target = 3;

Returns

Type	Description
String	The target.

getTargetBytes()

public ByteString getTargetBytes()

Server-defined resource path for the target of the operation.

string target = 3;

Returns

Type	Description
ByteString	The bytes for target.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

getVerb()

public String getVerb()

Name of the verb executed by the operation.

string verb = 4;

Returns

Type	Description
String	The verb.

getVerbBytes()

public ByteString getVerbBytes()

Name of the verb executed by the operation.

string verb = 4;

Returns

Type	Description
ByteString	The bytes for verb.

hasCreateTime()

public boolean hasCreateTime()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns

Type	Description
boolean	Whether the createTime field is set.

hasEndTime()

public boolean hasEndTime()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns

Type	Description
boolean	Whether the endTime field is set.

hasRequestResource()

public boolean hasRequestResource()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns

Type	Description
boolean	Whether the requestResource field is set.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public OperationMetadata.Builder newBuilderForType()

Returns

Type	Description
OperationMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OperationMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
OperationMetadata.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public OperationMetadata.Builder toBuilder()

Returns

Type	Description
OperationMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException