REST Resource: projects.operations
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Zasób: Operation
Ten zasób reprezentuje długo trwającą operację, która jest wynikiem wywołania interfejsu API sieci.
| Zapis JSON |
{
"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.
} |
| Pola |
name |
string
Nazwa przypisana przez serwer, która jest unikalna tylko w ramach tej samej usługi, która ją pierwotnie zwraca. Jeśli używasz domyślnego mapowania HTTP, name powinna być nazwą zasobu kończącą się na operations/{unique_id}.
|
metadata |
object
Metadane specyficzne dla usługi powiązane z operacją. Zwykle zawiera informacje o postępach i metadane, takie jak czas utworzenia. Niektóre usługi mogą nie udostępniać takich metadanych. Każda metoda, która zwraca operację długotrwałą, powinna zawierać dokumentację typu metadanych (jeśli występuje). Obiekt zawierający pola dowolnego typu. Dodatkowe pole "@type" zawiera identyfikator URI określający typ. Przykład: { "id": 1234, "@type": "types.example.com/standard/id" }.
|
done |
boolean
Jeśli wartość to false, oznacza to, że operacja jest w toku. Jeśli true, operacja została ukończona i dostępne są wartości error lub response.
|
Pole unii result. Wynik operacji, który może być wartością error lub prawidłową wartością response. Jeśli done == false, nie ustawia się ani error, ani response. Jeśli done == true, można ustawić tylko jedną z wartości error lub response. Niektóre usługi mogą nie zwracać wyniku. result może mieć tylko jedną z tych wartości: |
error |
object (Status)
Wynik błędu operacji w przypadku niepowodzenia lub anulowania.
|
response |
object
Normalna odpowiedź operacji w przypadku powodzenia. Jeśli oryginalna metoda nie zwraca danych w przypadku powodzenia, np. Delete, odpowiedź to google.protobuf.Empty. Jeśli oryginalna metoda to standardowa metoda Get/Create/Update, odpowiedź powinna być zasobem. W przypadku innych metod odpowiedź powinna mieć typ XxxResponse, gdzie Xxx to oryginalna nazwa metody. Jeśli na przykład oryginalna nazwa metody to TakeSnapshot(), wywnioskowany typ odpowiedzi to TakeSnapshotResponse. Obiekt zawierający pola dowolnego typu. Dodatkowe pole "@type" zawiera identyfikator URI określający typ. Przykład: { "id": 1234, "@type": "types.example.com/standard/id" }.
|
Metody |
|
|
Rozpoczyna asynchroniczne anulowanie długotrwałej operacji. |
|
|
Usuwa długo trwającą operację. |
|
|
Pobiera najnowszy stan długo trwającej operacji. |
|
|
Wyświetla operacje pasujące do filtra określonego w żądaniu. |
|
|
Czeka, aż określona długotrwała operacja zostanie zakończona lub osiągnie maksymalnie określony limit czasu, zwracając najnowszy stan. |
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-26 UTC.
[null,null,["Ostatnia aktualizacja: 2025-07-26 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. |"]]
