Class OperationMetadata (2.57.0) 

publicfinalclass OperationMetadataextendsGeneratedMessageV3implementsOperationMetadataOrBuilder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.functions.v2.OperationMetadata

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

API_VERSION_FIELD_NUMBER

publicstaticfinalintAPI_VERSION_FIELD_NUMBER
Field Value
Type Description
int

BUILD_NAME_FIELD_NUMBER

publicstaticfinalintBUILD_NAME_FIELD_NUMBER
Field Value
Type Description
int

CANCEL_REQUESTED_FIELD_NUMBER

publicstaticfinalintCANCEL_REQUESTED_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

publicstaticfinalintCREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

publicstaticfinalintEND_TIME_FIELD_NUMBER
Field Value
Type Description
int

OPERATION_TYPE_FIELD_NUMBER

publicstaticfinalintOPERATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_RESOURCE_FIELD_NUMBER

publicstaticfinalintREQUEST_RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_TOKEN_FIELD_NUMBER

publicstaticfinalintSOURCE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

STAGES_FIELD_NUMBER

publicstaticfinalintSTAGES_FIELD_NUMBER
Field Value
Type Description
int

STATUS_DETAIL_FIELD_NUMBER

publicstaticfinalintSTATUS_DETAIL_FIELD_NUMBER
Field Value
Type Description
int

TARGET_FIELD_NUMBER

publicstaticfinalintTARGET_FIELD_NUMBER
Field Value
Type Description
int

VERB_FIELD_NUMBER

publicstaticfinalintVERB_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticOperationMetadatagetDefaultInstance()
Returns
Type Description
OperationMetadata

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticOperationMetadata.BuildernewBuilder()
Returns
Type Description
OperationMetadata.Builder

newBuilder(OperationMetadata prototype)

publicstaticOperationMetadata.BuildernewBuilder(OperationMetadataprototype)
Parameter
Name Description
prototype OperationMetadata
Returns
Type Description
OperationMetadata.Builder

parseDelimitedFrom(InputStream input)

publicstaticOperationMetadataparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
OperationMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticOperationMetadataparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OperationMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticOperationMetadataparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
OperationMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticOperationMetadataparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OperationMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticOperationMetadataparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
OperationMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticOperationMetadataparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OperationMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticOperationMetadataparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
OperationMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticOperationMetadataparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OperationMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticOperationMetadataparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
OperationMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticOperationMetadataparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OperationMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticOperationMetadataparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
OperationMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticOperationMetadataparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OperationMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<OperationMetadata>parser()
Returns
Type Description
Parser<OperationMetadata>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getApiVersion()

publicStringgetApiVersion()

API version used to start the operation.

string api_version = 7;

Returns
Type Description
String

The apiVersion.

getApiVersionBytes()

publicByteStringgetApiVersionBytes()

API version used to start the operation.

string api_version = 7;

Returns
Type Description
ByteString

The bytes for apiVersion.

getBuildName()

publicStringgetBuildName()

The build name of the function for create and update operations.

string build_name = 13;

Returns
Type Description
String

The buildName.

getBuildNameBytes()

publicByteStringgetBuildNameBytes()

The build name of the function for create and update operations.

string build_name = 13;

Returns
Type Description
ByteString

The bytes for buildName.

getCancelRequested()

publicbooleangetCancelRequested()

Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.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()

publicTimestampgetCreateTime()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

publicTimestampOrBuildergetCreateTimeOrBuilder()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

publicOperationMetadatagetDefaultInstanceForType()
Returns
Type Description
OperationMetadata

getEndTime()

publicTimestampgetEndTime()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

publicTimestampOrBuildergetEndTimeOrBuilder()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
TimestampOrBuilder

getOperationType()

publicOperationTypegetOperationType()

The operation type.

.google.cloud.functions.v2.OperationType operation_type = 11;

Returns
Type Description
OperationType

The operationType.

getOperationTypeValue()

publicintgetOperationTypeValue()

The operation type.

.google.cloud.functions.v2.OperationType operation_type = 11;

Returns
Type Description
int

The enum numeric value on the wire for operationType.

getParserForType()

publicParser<OperationMetadata>getParserForType()
Returns
Type Description
Parser<OperationMetadata>
Overrides

getRequestResource()

publicAnygetRequestResource()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
Type Description
Any

The requestResource.

getRequestResourceOrBuilder()

publicAnyOrBuildergetRequestResourceOrBuilder()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
Type Description
AnyOrBuilder

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getSourceToken()

publicStringgetSourceToken()

An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

string source_token = 10;

Returns
Type Description
String

The sourceToken.

getSourceTokenBytes()

publicByteStringgetSourceTokenBytes()

An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

string source_token = 10;

Returns
Type Description
ByteString

The bytes for sourceToken.

getStages(int index)

publicStagegetStages(intindex)

Mechanism for reporting in-progress stages

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

Parameter
Name Description
index int
Returns
Type Description
Stage

getStagesCount()

publicintgetStagesCount()

Mechanism for reporting in-progress stages

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

Returns
Type Description
int

getStagesList()

publicList<Stage>getStagesList()

Mechanism for reporting in-progress stages

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

Returns
Type Description
List<Stage>

getStagesOrBuilder(int index)

publicStageOrBuildergetStagesOrBuilder(intindex)

Mechanism for reporting in-progress stages

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

Parameter
Name Description
index int
Returns
Type Description
StageOrBuilder

getStagesOrBuilderList()

publicList<?extendsStageOrBuilder>getStagesOrBuilderList()

Mechanism for reporting in-progress stages

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

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

getStatusDetail()

publicStringgetStatusDetail()

Human-readable status of the operation, if any.

string status_detail = 5;

Returns
Type Description
String

The statusDetail.

getStatusDetailBytes()

publicByteStringgetStatusDetailBytes()

Human-readable status of the operation, if any.

string status_detail = 5;

Returns
Type Description
ByteString

The bytes for statusDetail.

getTarget()

publicStringgetTarget()

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

string target = 3;

Returns
Type Description
String

The target.

getTargetBytes()

publicByteStringgetTargetBytes()

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

string target = 3;

Returns
Type Description
ByteString

The bytes for target.

getVerb()

publicStringgetVerb()

Name of the verb executed by the operation.

string verb = 4;

Returns
Type Description
String

The verb.

getVerbBytes()

publicByteStringgetVerbBytes()

Name of the verb executed by the operation.

string verb = 4;

Returns
Type Description
ByteString

The bytes for verb.

hasCreateTime()

publicbooleanhasCreateTime()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
boolean

Whether the createTime field is set.

hasEndTime()

publicbooleanhasEndTime()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
boolean

Whether the endTime field is set.

hasRequestResource()

publicbooleanhasRequestResource()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
Type Description
boolean

Whether the requestResource field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicOperationMetadata.BuildernewBuilderForType()
Returns
Type Description
OperationMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedOperationMetadata.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
OperationMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicOperationMetadata.BuildertoBuilder()
Returns
Type Description
OperationMetadata.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

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月30日 UTC.