Class Operation
This resource represents a long-running operation that is the result of a
network API call.
Inheritance
System.Object
Operation
Implements
Google.Protobuf.IBufferMessage
Inherited Members
System.Object.ToString()
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Google.LongRunning.dll
Syntax
public sealed class Operation : IMessage<Operation>, IEquatable<Operation>, IDeepCloneable<Operation>, IBufferMessage, IMessage
Constructors
Operation()
Declaration
Operation(Operation)
Declaration
public Operation(Operation other)
Parameters
Properties
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.
Declaration
public bool Done { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Error
The error result of the operation in case of failure or cancellation.
Declaration
public Status Error { get; set; }
Property Value
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.
Declaration
public Any Metadata { get; set; }
Property Value
Name
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}
.
Declaration
public string Name { get; set; }
Property Value
Type |
Description |
System.String |
|
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
. 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
.
Declaration
public Any Response { get; set; }
Property Value
ResultCase
Declaration
public Operation.ResultOneofCase ResultCase { get; }
Property Value