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.
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 google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
IAM Permissions
Requires the following IAM permission on the name resource:
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
IAM Permissions
Requires the following IAM permission on the name resource:
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.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
IAM Permissions
Requires the following IAM permission on the name resource:
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.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
IAM Permissions
Requires the following IAM permission on the name resource:
A list of operations that matches the specified filter in the request.
next_page_token
string
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
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-07-28 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eOperations\u003c/code\u003e interface manages long-running operations in an API service, allowing clients to receive asynchronous responses by polling or using other APIs like Pub/Sub.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCancelOperation\u003c/code\u003e allows clients to initiate asynchronous cancellation of a long-running operation, with the operation not being deleted but receiving a \u003ccode\u003eCANCELLED\u003c/code\u003e status code if successful.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eDeleteOperation\u003c/code\u003e permits the client to signal disinterest in an operation's result without canceling the operation itself, effectively removing it from the client's view.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGetOperation\u003c/code\u003e enables clients to retrieve the latest state of a long-running operation, facilitating periodic polling to check for completion.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eWaitOperation\u003c/code\u003e allows a client to wait until the operation is complete or times out, however it is on a best effort basis, and may not always be entirely accurate.\u003c/p\u003e\n"]]],[],null,["# Package google.longrunning\n\nIndex\n-----\n\n- [Operations](/apigee/docs/reference/apis/apihub/rpc/google.longrunning#google.longrunning.Operations) (interface)\n- [CancelOperationRequest](/apigee/docs/reference/apis/apihub/rpc/google.longrunning#google.longrunning.CancelOperationRequest) (message)\n- [DeleteOperationRequest](/apigee/docs/reference/apis/apihub/rpc/google.longrunning#google.longrunning.DeleteOperationRequest) (message)\n- [GetOperationRequest](/apigee/docs/reference/apis/apihub/rpc/google.longrunning#google.longrunning.GetOperationRequest) (message)\n- [ListOperationsRequest](/apigee/docs/reference/apis/apihub/rpc/google.longrunning#google.longrunning.ListOperationsRequest) (message)\n- [ListOperationsResponse](/apigee/docs/reference/apis/apihub/rpc/google.longrunning#google.longrunning.ListOperationsResponse) (message)\n- [Operation](/apigee/docs/reference/apis/apihub/rpc/google.longrunning#google.longrunning.Operation) (message)\n- [WaitOperationRequest](/apigee/docs/reference/apis/apihub/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](/apigee/docs/reference/apis/apihub/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\nCancelOperationRequest\n----------------------\n\nThe request message for [Operations.CancelOperation](/apigee/docs/reference/apis/apihub/rpc/google.longrunning#google.longrunning.Operations.CancelOperation).\n\nDeleteOperationRequest\n----------------------\n\nThe request message for [Operations.DeleteOperation](/apigee/docs/reference/apis/apihub/rpc/google.longrunning#google.longrunning.Operations.DeleteOperation).\n\nGetOperationRequest\n-------------------\n\nThe request message for [Operations.GetOperation](/apigee/docs/reference/apis/apihub/rpc/google.longrunning#google.longrunning.Operations.GetOperation).\n\nListOperationsRequest\n---------------------\n\nThe request message for [Operations.ListOperations](/apigee/docs/reference/apis/apihub/rpc/google.longrunning#google.longrunning.Operations.ListOperations).\n\nListOperationsResponse\n----------------------\n\nThe response message for [Operations.ListOperations](/apigee/docs/reference/apis/apihub/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](/apigee/docs/reference/apis/apihub/rpc/google.longrunning#google.longrunning.Operations.WaitOperation)."]]
