Google.LongRunning - Class Operation (3.3.0)

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

Reference documentation and code samples for the Google.LongRunning class Operation.

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

Inheritance

object > Operation

Implements

IMessage Operation, IEquatable Operation, IDeepCloneable Operation, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.LongRunning

Assembly

Google.LongRunning.dll

Constructors

Operation()

public Operation()

Operation(Operation)

public Operation(Operation other)

Parameter
Name	Description
`other`	`Operation`

Properties

Done

public bool Done { get; set; }

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.

Property Value
Type	Description
`bool`

Error

public Status Error { get; set; }

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

Property Value
Type	Description
`Status`

Metadata

public Any Metadata { get; set; }

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

Property Value
Type	Description
`Any`

Name

public string Name { get; set; }

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

Property Value
Type	Description
`string`

Response

public Any Response { get; set; }

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. 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.

Property Value
Type	Description
`Any`

ResultCase

public Operation.ResultOneofCase ResultCase { get; }

Property Value
Type	Description
`OperationResultOneofCase`