Page Summary
-
The
Operationresource represents a long-running operation initiated by a network API call. -
Each operation has a unique name, metadata (often with progress information), and a status indicating if it's done.
-
Upon completion (
doneistrue), an operation provides either anerroror aresponseindicating the outcome. -
The
responsefield contains the operation's result, which varies depending on the original API method called.
Index
-
Operation(message)
Operation
This resource represents a long-running operation that is the result of a network API call.
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/{unique_id}
.
done
bool
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
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 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
.
