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.
Fields
namestring
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/{uniqueId}.
metadataobject
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" }.
doneboolean
If the value isfalse, it means the operation is still in progress. Iftrue, the operation is completed, and eithererrororresponseis available.
resultUnion type
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.
responseobject
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" }.
JSON representation
{"name":string,"metadata":{"@type":string,field1:...,...},"done":boolean,// result"error":{object (Status)},"response":{"@type":string,field1:...,...}// Union type}
[[["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-27 UTC."],[],[],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.\nFields `name` `string` \nThe 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/{uniqueId}`.\n`metadata` `object` \nservice-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.\n\nAn 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\" }`.\n`done` `boolean` \nIf 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. \n`result` `Union type` \nThe 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:\n`error` `object (`[Status](/vertex-ai/docs/reference/rest/Shared.Types/ListOperationsResponse#Status)`)` \nThe error result of the operation in case of failure or cancellation.\n`response` `object` \nThe 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`.\n\nAn 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\" }`."]]
