Package google.longrunning
Operacja
Ten zasób reprezentuje długo trwającą operację będącą wynikiem wywołania sieciowego interfejsu API.
| Pola |
name |
string
Nazwa przypisana przez serwer, która jest niepowtarzalna w tej samej usłudze, która została pierwotnie zwrócona. Jeśli używasz domyślnego mapowania HTTP, name powinna być nazwą zasobu kończącą się operations/{unique_id}.
|
metadata |
Any
Metadane dotyczące konkretnej usługi, które są powiązane z operacją. Zwykle zawiera on informacje o postępach i typowe metadane, np. czas utworzenia. Niektóre usługi mogą nie udostępniać takich metadanych. Każda metoda, która zwraca długo trwającą operację, powinna udokumentować typ metadanych (jeśli taki istnieje).
|
done |
bool
Wartość false oznacza, że operacja jest w toku. Jeśli ustawiona jest wartość true, operacja została ukończona i dostępna jest wartość error lub response.
|
Pole sumy result. Wynik operacji, którym może być error lub prawidłowy element response. Jeśli done == false, nie ustawiono ani error, ani response. Jeśli done == true, można ustawić dokładnie jedno z tych wartości: error lub response. Niektóre usługi mogą nie zapewniać oczekiwanych wyników. result może mieć tylko jedną z tych wartości: |
error |
Status
Wynik błędu operacji w przypadku niepowodzenia lub anulowania.
|
response |
Any
Normalna, udana odpowiedź operacji. Jeśli pierwotna metoda nie zwróci żadnych danych o powodzeniu, np. Delete, odpowiedź to google.protobuf.Empty. Jeśli pierwotna metoda to standardowa metoda Get/Create/Update, odpowiedzią powinna być zasób. W przypadku innych metod odpowiedź powinna mieć typ XxxResponse, gdzie Xxx to pierwotna nazwa metody. Jeśli np. pierwotna nazwa metody to TakeSnapshot(), przewidywany typ odpowiedzi to TakeSnapshotResponse.
|
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: 2023-12-01 UTC.
[null,null,["Ostatnia aktualizacja: 2023-12-01 UTC."],[[["The `Operation` resource represents a long-running operation initiated by a network API call."],["Each operation has a unique name, metadata (often with progress information), and a status indicating if it's done."],["Upon completion (`done` is `true`), an operation provides either an `error` or a `response` indicating the outcome."],["The `response` field contains the operation's result, which varies depending on the original API method called."]]],["A long-running network API call is represented by an \"Operation\" resource. This resource includes a unique `name`, service-specific `metadata` about progress, and a `done` status flag. Upon completion (`done` is true), the `result` field will contain either an `error` status or a successful `response`. If the operation is in progress (`done` is false) `result` will not be set. The `response` contains data if it was a successful operation.\n"]]
