Stay organized with collectionsSave and categorize content based on your preferences.
Resource: Operation
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 oferrororresponsecan 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, successful response of the operation. 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-10 UTC."],[[["\u003cp\u003eThis resource defines a long-running operation resulting from a network API call, represented in JSON format with fields like \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003emetadata\u003c/code\u003e, and \u003ccode\u003edone\u003c/code\u003e to track its status.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eresult\u003c/code\u003e field indicates the outcome of the operation, which can be either an \u003ccode\u003eerror\u003c/code\u003e object in case of failure or a \u003ccode\u003eresponse\u003c/code\u003e object if successful, with only one being set when the \u003ccode\u003edone\u003c/code\u003e field is true.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ename\u003c/code\u003e field provides a server-assigned unique identifier for the operation within the service, and the \u003ccode\u003emetadata\u003c/code\u003e field contains service-specific information, such as progress and creation time, if provided.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003edone\u003c/code\u003e field specifies whether the operation is still in progress (\u003ccode\u003efalse\u003c/code\u003e) or has completed (\u003ccode\u003etrue\u003c/code\u003e), where upon completion, one of the \u003ccode\u003eerror\u003c/code\u003e or \u003ccode\u003eresponse\u003c/code\u003e fields will be populated.\u003c/p\u003e\n"],["\u003cp\u003eSeveral methods are provided to manage these operations, such as \u003ccode\u003ecancel\u003c/code\u003e to asynchronously cancel an operation, \u003ccode\u003eget\u003c/code\u003e to check its current state, and \u003ccode\u003elist\u003c/code\u003e to retrieve operations matching a specified filter.\u003c/p\u003e\n"]]],[],null,["# REST Resource: projects.locations.operations\n\nResource: Operation\n-------------------\n\nThis resource represents a long-running operation that is the result of a network API call."]]
