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 is set. result can be only one of the following: |
||
error |
The error result of the operation in case of failure or cancellation. |
|
response |
The normal response of the operation in case of success. If the original method returns no data on success, such as An object containing fields of an arbitrary type. An additional field |
Status
The Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status
message contains three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the API Design Guide.
JSON representation | |
---|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Fields | |
---|---|
code |
The status code, which should be an enum value of |
message |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the |
details[] |
A list of messages that carry the error details. There is a common set of message types for APIs to use. 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. |