AI-generated Key Takeaways
-
The
Operation
resource represents a long-running network API call with fields indicating its name, metadata, status, and result. -
Operations can be monitored using the
done
field; iffalse
, the operation is ongoing, iftrue
, it's completed with either anerror
or aresponse
. -
Users can manage operations via methods like
cancel
,delete
,get
,list
, andwait
to interact with their progress and outcomes.
Resource: Operation
This resource represents a long-running operation that is the result of a network API call.
JSON representation |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Fields | |
---|---|
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 |
metadata |
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. An object containing fields of an arbitrary type. An additional field |
done |
If the value is |
Union field result . The operation result, which can be either an error or a valid response . If done == false , neither error nor response is set. If done == true , exactly one of error or response can be set. Some services might not provide the result. result can be only one of the following: |
|
error |
The error result of the operation in case of failure or cancellation. |
response |
The normal, successful response of the operation. If the original method returns no data on success, such as An object containing fields of an arbitrary type. An additional field |
Methods |
|
---|---|
|
Starts asynchronous cancellation on a long-running operation. |
|
Deletes a long-running operation. |
|
Gets the latest state of a long-running operation. |
|
Lists operations that match the specified filter in the request. |
|
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. |