Ten zasób reprezentuje długotrwałą operację będącą wynikiem wywołania interfejsu API sieci.
Zapis JSON |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Pola | |
---|---|
name |
Nazwa przypisywana przez serwer, która jest unikalna w obrębie tej samej usługi, która została pierwotnie zwrócona. Jeśli używasz domyślnego mapowania HTTP, |
metadata |
metadane związane z usługą powiązane z operacją. Zwykle zawiera informacje o postępach i popularne metadane, takie jak czas utworzenia. Niektóre usługi mogą nie udostępniać takich metadanych. Każda metoda zwracająca długotrwałą operację powinna udokumentować typ metadanych, jeśli taki istnieje. Obiekt zawierający pola dowolnego typu. Dodatkowe pole |
done |
Jeśli wartość to |
Pole sumy result . Wynik operacji, który może być error lub prawidłowy response . Jeśli done == false , nie są ustawione właściwości error ani response . Jeśli done == true , można ustawić dokładnie 1 z error lub response . Niektóre usługi mogą nie podawać wyników. result może mieć tylko jedną z tych wartości: |
|
error |
Wynik błędu operacji w przypadku niepowodzenia lub anulowania. |
response |
Normalna, udana odpowiedź operacji. Jeśli pierwotna metoda nie zwraca żadnych danych dotyczących powodzenia, takich jak Obiekt zawierający pola dowolnego typu. Dodatkowe pole |