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.
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.
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 google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
This resource represents a long-running operation that is the result of a network API call.
Fields
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}.
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
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.
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:
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-16 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eOperations\u003c/code\u003e interface manages long-running operations in API services, allowing clients to asynchronously receive responses through polling or other APIs.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGetOperation\u003c/code\u003e retrieves the latest state of a long-running operation, enabling clients to poll for results at intervals.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eListOperations\u003c/code\u003e allows listing operations that match a specified filter, returning \u003ccode\u003eUNIMPLEMENTED\u003c/code\u003e if unsupported by the server.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eWaitOperation\u003c/code\u003e waits for a long-running operation to complete or reach a specified timeout, providing the latest state, but works on a best-effort basis.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eOperation\u003c/code\u003e represents the result of a long-running network API call, containing the operation's name, metadata, status (done/not done), and either an error or a response.\u003c/p\u003e\n"]]],[],null,["# Package google.longrunning\n\nIndex\n-----\n\n- [Operations](/functions/docs/reference/rpc/google.longrunning#google.longrunning.Operations) (interface)\n- [GetOperationRequest](/functions/docs/reference/rpc/google.longrunning#google.longrunning.GetOperationRequest) (message)\n- [ListOperationsRequest](/functions/docs/reference/rpc/google.longrunning#google.longrunning.ListOperationsRequest) (message)\n- [ListOperationsResponse](/functions/docs/reference/rpc/google.longrunning#google.longrunning.ListOperationsResponse) (message)\n- [Operation](/functions/docs/reference/rpc/google.longrunning#google.longrunning.Operation) (message)\n- [WaitOperationRequest](/functions/docs/reference/rpc/google.longrunning#google.longrunning.WaitOperationRequest) (message)\n\nOperations\n----------\n\nManages long-running operations with an API service.\n\nWhen an API method normally takes long time to complete, it can be designed to return [Operation](/functions/docs/reference/rpc/google.longrunning#google.longrunning.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.\n\nGetOperationRequest\n-------------------\n\nThe request message for [Operations.GetOperation](/functions/docs/reference/rpc/google.longrunning#google.longrunning.Operations.GetOperation).\n\nListOperationsRequest\n---------------------\n\nThe request message for [Operations.ListOperations](/functions/docs/reference/rpc/google.longrunning#google.longrunning.Operations.ListOperations).\n\nListOperationsResponse\n----------------------\n\nThe response message for [Operations.ListOperations](/functions/docs/reference/rpc/google.longrunning#google.longrunning.Operations.ListOperations).\n\nOperation\n---------\n\nThis resource represents a long-running operation that is the result of a network API call.\n\nWaitOperationRequest\n--------------------\n\nThe request message for [Operations.WaitOperation](/functions/docs/reference/rpc/google.longrunning#google.longrunning.Operations.WaitOperation)."]]
