Class Operation<TMetadata, TResponse>

Namespace

Uralstech.UCloud.Operations.Generic

This resource represents a long-running operation that is the result of a network API call.

public class Operation<TMetadata, TResponse>

Type Parameters

TMetadata

The type of the operation's metadata.

TResponse

The type of the operation's response.

Inheritance

object

Operation<TMetadata, TResponse>

Derived

Operation

Fields

Done

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either Error or Response is available.

public bool Done

Field Value

bool

Error

The error result of the operation in case of failure or cancellation.

public OperationStatus Error

Field Value

OperationStatus

Metadata

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time.

public TMetadata Metadata

Field Value

TMetadata

Remarks

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time.

Name

The server-assigned name, which is only unique within the same service that originally returns it.

public string Name

Field Value

string

Remarks

If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

Response

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty.

public TResponse Response

Field Value

TResponse

Remarks

If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse,
where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.