The Operations resource represents a long-running operation within Cloud Storage.
Resource representations
{ "name" : s tr i n g , "metadata" : { "@type" : s tr i n g , f ield 1 : ... , ... }, "done" : boolea n , // Union field result can include either an error or a response: "error" : { "code" : i nte ger , "message" : s tr i n g , "details" : [ { "@type" : s tr i n g , f ield 1 : ... , ... } ] }, "response" : { "@type" : s tr i n g , f ield 1 : ... , ... } }
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 name
should be
a resource name ending with operations/{operation_id}
.
done
boolean
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.
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 google.rpc.Code
.
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 "@type"
contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }
.
response
object
The normal, successful response of the operation. 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
.
An object containing fields of an arbitrary type.
An additional field "@type"
contains a URI identifying the type.
Example: { "id": 1234, "@type": "types.example.com/standard/id" }
.
Methods
The methods for working with long-running operations are as follows:
- cancel
- Starts asynchronous cancellation on a long-running operation.
- get
- Gets the latest state of a long-running operation.
- list
- Lists service operations that match the specified filter in the request.
- advanceRelocateBucket
- Initiates the final synchronization of a bucket relocation operation.
