Class OperationMetadata (2.50.0) 

public final class OperationMetadata extends GeneratedMessageV3 implements OperationMetadataOrBuilder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.functions.v2.OperationMetadata

Inheritance

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

Static Fields

API_VERSION_FIELD_NUMBER

public static final int API_VERSION_FIELD_NUMBER
Field Value
Type Description
int

BUILD_NAME_FIELD_NUMBER

public static final int BUILD_NAME_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

OPERATION_TYPE_FIELD_NUMBER

public static final int OPERATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_RESOURCE_FIELD_NUMBER

public static final int REQUEST_RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_TOKEN_FIELD_NUMBER

public static final int SOURCE_TOKEN_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

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.

getBuildName()

public String getBuildName()

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

string build_name = 13;

Returns
Type Description
String

The buildName.

getBuildNameBytes()

public ByteString getBuildNameBytes()

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

string build_name = 13;

Returns
Type Description
ByteString

The bytes for buildName.

getCancelRequested()

public boolean getCancelRequested()

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()

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

getOperationType()

public OperationType getOperationType()

The operation type.

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

Returns
Type Description
OperationType

The operationType.

getOperationTypeValue()

public int getOperationTypeValue()

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()

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

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

getSourceToken()

public String getSourceToken()

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()

public ByteString getSourceTokenBytes()

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)

public Stage getStages(int index)

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2.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.v2.Stage stages = 9;

Returns
Type Description
int

getStagesList()

public List<Stage> getStagesList()

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2.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.v2.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.v2.Stage stages = 9;

Returns
Type Description
List<? extends com.google.cloud.functions.v2.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.

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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