Cloud Functions v2 API - Class OperationMetadata (1.3.0)

Version 1.3.0

• 1.7.0 (latest)
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class OperationMetadata : IMessage<OperationMetadata>, IEquatable<OperationMetadata>, IDeepCloneable<OperationMetadata>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Functions v2 API class OperationMetadata.

Represents the metadata of the long-running operation.

Inheritance

object > OperationMetadata

Implements

IMessageOperationMetadata, IEquatableOperationMetadata, IDeepCloneableOperationMetadata, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Functions.V2

Assembly

Google.Cloud.Functions.V2.dll

Constructors

OperationMetadata()

public OperationMetadata()

OperationMetadata(OperationMetadata)

public OperationMetadata(OperationMetadata other)

Parameter
Name	Description
other	OperationMetadata

Properties

ApiVersion

public string ApiVersion { get; set; }

API version used to start the operation.

Property Value
Type	Description
string

CancelRequested

public bool CancelRequested { get; set; }

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][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED.

Property Value
Type	Description
bool

CreateTime

public Timestamp CreateTime { get; set; }

The time the operation was created.

Property Value
Type	Description
Timestamp

EndTime

public Timestamp EndTime { get; set; }

The time the operation finished running.

Property Value
Type	Description
Timestamp

RequestResource

public Any RequestResource { get; set; }

The original request that started the operation.

Property Value
Type	Description
Any

Stages

public RepeatedField<Stage> Stages { get; }

Mechanism for reporting in-progress stages

Property Value
Type	Description
RepeatedFieldStage

StatusDetail

public string StatusDetail { get; set; }

Human-readable status of the operation, if any.

Property Value
Type	Description
string

Target

public string Target { get; set; }

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

Property Value
Type	Description
string

Verb

public string Verb { get; set; }

Name of the verb executed by the operation.

Property Value
Type	Description
string