Zasób: Operacja
Ten zasób reprezentuje długotrwałą operację będącą wynikiem wywołania sieciowego interfejsu API.
Reprezentacja JSON |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Pola | |
---|---|
name | Nazwa przypisana przez serwer, która jest unikalna tylko w ramach tej samej usługi, która pierwotnie ją zwróciła. Jeśli używasz domyślnego mapowania HTTP, |
metadata | Metadane specyficzne dla usługi powiązane z operacją. Zwykle zawiera informacje o postępie i typowe metadane, takie jak czas utworzenia. Niektóre usługi mogą nie udostępniać takich metadanych. Każda metoda zwracająca długotrwałą operację powinna dokumentować typ metadanych, jeśli taki istnieje. Obiekt zawierający pola dowolnego typu. Dodatkowe pole |
done | Jeśli wartość to |
Wynik result Unii. Wynik operacji, który może być error lub prawidłową response . Jeśli done == false , nie zostanie ustawiony ani error , ani response . Jeśli done == true , można ustawić dokładnie jeden error lub response . Niektóre usługi mogą nie zapewniać wyniku. result może być tylko jeden z następujących: | |
error | Wynik błędu operacji w przypadku niepowodzenia lub anulowania. |
response | Normalna, pomyślna reakcja operacji. Jeśli oryginalna metoda nie zwróci żadnych danych o powodzeniu, np. Obiekt zawierający pola dowolnego typu. Dodatkowe pole |
Metody | |
---|---|
| Pobiera najnowszy stan długotrwałej operacji. |