Stay organized with collections
Save and categorize content based on your preferences.
This resource represents a long-running operation that is the result of a network API call.
JSON representation
{"name": string,"metadata": {"@type": string,field1: ...,...},"done": boolean,// Union field result can be only one of the following:"error": {object (Status)},"response": {"@type": string,field1: ...,...}// End of list of possible types for union field result.}
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}.
metadata
object
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.
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" }.
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.
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 error result of the operation in case of failure or cancellation.
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" }.
Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the API Design Guide.
The status code, which should be an enum value of google.rpc.Code.
message
string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
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" }.
[[["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-05-19 UTC."],[[["\u003cp\u003eThis resource documents the structure of a long-running operation's response, which is obtained via a network API call.\u003c/p\u003e\n"],["\u003cp\u003eThe operation's \u003ccode\u003ename\u003c/code\u003e field is a unique server-assigned identifier, typically in the format of a resource name ending with \u003ccode\u003eoperations/{unique_id}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003edone\u003c/code\u003e field indicates whether the operation is complete (\u003ccode\u003etrue\u003c/code\u003e) or still in progress (\u003ccode\u003efalse\u003c/code\u003e), and if complete, either an \u003ccode\u003eerror\u003c/code\u003e or \u003ccode\u003eresponse\u003c/code\u003e field will be populated.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eresult\u003c/code\u003e field is a union type, meaning it will contain either an \u003ccode\u003eerror\u003c/code\u003e object, detailing the failure or cancellation, or a \u003ccode\u003eresponse\u003c/code\u003e object containing the successful result.\u003c/p\u003e\n"],["\u003cp\u003eStatus error model consists of three components: \u003ccode\u003ecode\u003c/code\u003e, \u003ccode\u003emessage\u003c/code\u003e, and \u003ccode\u003edetails\u003c/code\u003e which are designed to be applicable across various programming environments.\u003c/p\u003e\n"]]],[],null,[]]