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 fieldresultcan be only one of the following:"error":{object (Status)},"response":{"@type":string,field1:...,...}// End of list of possible types for union fieldresult.}
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, thenameshould be a resource name ending withoperations/{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 isfalse, it means the operation is still in progress. Iftrue, the operation is completed, and eithererrororresponseis available.
Union fieldresult. The operation result, which can be either anerroror a validresponse. Ifdone==false, neithererrornorresponseis set. Ifdone==true, exactly one oferrororresponsemay be set. Some services might not provide the result.resultcan be only one of the following:
The error result of the operation in case of failure or cancellation.
response
object
The normal response of the operation in case of success. If the original method returns no data on success, such asDelete, the response isgoogle.protobuf.Empty. If the original method is standardGet/Create/Update, the response should be the resource. For other methods, the response should have the typeXxxResponse, whereXxxis the original method name. For example, if the original method name isTakeSnapshot(), the inferred response type isTakeSnapshotResponse.
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-06-16 UTC."],[[["\u003cp\u003eThis resource describes an "Operation," which represents a long-running operation resulting from a network API call.\u003c/p\u003e\n"],["\u003cp\u003eThe JSON representation includes fields like \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003emetadata\u003c/code\u003e, \u003ccode\u003edone\u003c/code\u003e, and a union field \u003ccode\u003eresult\u003c/code\u003e that can hold either an \u003ccode\u003eerror\u003c/code\u003e or a \u003ccode\u003eresponse\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003edone\u003c/code\u003e field indicates if the operation is complete; if \u003ccode\u003etrue\u003c/code\u003e, either \u003ccode\u003eerror\u003c/code\u003e or \u003ccode\u003eresponse\u003c/code\u003e will be populated.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eresult\u003c/code\u003e field represents the outcome of the operation, which will be an error or a valid response depending on the operation status.\u003c/p\u003e\n"],["\u003cp\u003eThere are two methods available: \u003ccode\u003eget\u003c/code\u003e, which retrieves the latest state of an operation, and \u003ccode\u003elist\u003c/code\u003e, which returns operations matching a given filter.\u003c/p\u003e\n"]]],[],null,["# REST Resource: apps.operations\n\n- [Resource: Operation](#Operation)\n - [JSON representation](#Operation.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Operation\n-------------------\n\nThis resource represents a long-running operation that is the result of a network API call."]]
