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"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-06-05 UTC."],[[["\u003cp\u003eAn \u003ccode\u003eOperation\u003c/code\u003e resource represents a long-running API call, tracked by a server-assigned \u003ccode\u003ename\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eOperations have metadata, and a status (\u003ccode\u003edone\u003c/code\u003e) field that indicates completion or progress.\u003c/p\u003e\n"],["\u003cp\u003eUpon completion, the \u003ccode\u003eresult\u003c/code\u003e field provides either an \u003ccode\u003eerror\u003c/code\u003e or a \u003ccode\u003eresponse\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage Operations using methods like \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e, \u003ccode\u003ecancel\u003c/code\u003e, \u003ccode\u003edelete\u003c/code\u003e, and \u003ccode\u003ewait\u003c/code\u003e.\u003c/p\u003e\n"]]],["This resource details a long-running operation resulting from a network API call. Key attributes include `name` (unique server-assigned identifier), `metadata` (service-specific information), and `done` (operation status). Upon completion (`done` is true), the `result` field will contain either an `error` or a `response`. Available methods allow users to `cancel`, `delete`, `get`, `list`, or `wait` for operations. The response type is determined by the original method called.\n"],null,["# REST Resource: projects.operations\n\nResource: Operation\n-------------------\n\nThis resource represents a long-running operation that is the result of a network API call.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"metadata\": { \"@type\": string, field1: ..., ... }, \"done\": boolean, // Union field `result` can be only one of the following: \"error\": { object (/earth-engine/reference/rest/Shared.Types/ListOperationsResponse#Status) }, \"response\": { \"@type\": string, field1: ..., ... } // End of list of possible types for union field `result`. } ``` |\n\n| Fields ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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}`. |\n| `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\" }`. |\n| `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. |\n| 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: ||\n| `error` | `object (`[Status](/earth-engine/reference/rest/Shared.Types/ListOperationsResponse#Status)`)` The error result of the operation in case of failure or cancellation. |\n| `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\" }`. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|\n| ### [cancel](/earth-engine/reference/rest/v1beta/projects.operations/cancel) | Starts asynchronous cancellation on a long-running operation. |\n| ### [delete](/earth-engine/reference/rest/v1beta/projects.operations/delete) | Deletes a long-running operation. |\n| ### [get](/earth-engine/reference/rest/v1beta/projects.operations/get) | Gets the latest state of a long-running operation. |\n| ### [list](/earth-engine/reference/rest/v1beta/projects.operations/list) | Lists operations that match the specified filter in the request. |\n| ### [wait](/earth-engine/reference/rest/v1beta/projects.operations/wait) | Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. |"]]
