The Operations resource represents a long-running operation within Cloud Storage.
Resource representations
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field result can include either an error or a response: "error": { "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] }, "response": { "@type": string, field1: ..., ... } }
Property name | Value | Description | Notes |
---|---|---|---|
name |
string |
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 |
object |
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 |
boolean |
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 |
object |
The error result of the operation in case of failure or cancellation. |
|
error.code |
integer |
The status code, which should be an enum value of |
|
error.message |
string |
A developer-facing error message, which should be in English. |
|
error.details[] |
object |
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 |
|
response |
object |
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
The methods for working with long-running operations are as follows: