Index
Operations
(interface)CancelOperationRequest
(message)GetOperationRequest
(message)ListOperationsRequest
(message)ListOperationsResponse
(message)Operation
(message)WaitOperationRequest
(message)
Operations
Manages long-running operations with an API service.
When an API method normally takes long time to complete, it can be designed to return Operation
to the client, and the client can use this interface to receive the real response asynchronously by polling the operation resource, or pass the operation resource to another API (such as Pub/Sub API) to receive the response. Any API service that returns long-running operations should implement the Operations
interface so developers can have a consistent client experience.
CancelOperation |
---|
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns
|
GetOperation |
---|
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
ListOperations |
---|
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns
|
WaitOperation |
---|
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns
|
CancelOperationRequest
The request message for Operations.CancelOperation
.
Fields | |
---|---|
name |
The name of the operation resource to be cancelled. |
GetOperationRequest
The request message for Operations.GetOperation
.
Fields | |
---|---|
name |
The name of the operation resource. |
ListOperationsRequest
The request message for Operations.ListOperations
.
Fields | |
---|---|
name |
The name of the operation's parent resource. |
filter |
The standard list filter. |
page_size |
The standard list page size. |
page_token |
The standard list page token. |
ListOperationsResponse
The response message for Operations.ListOperations
.
Fields | |
---|---|
operations[] |
A list of operations that matches the specified filter in the request. |
next_page_token |
The standard List next-page token. |
Operation
This resource represents a long-running operation that is the result of a network API call.
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. |
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 |
WaitOperationRequest
The request message for Operations.WaitOperation
.
Fields | |
---|---|
name |
The name of the operation resource to wait on. |
timeout |
The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. |