Zasób: Operacja
Ten zasób reprezentuje długo trwającą operację będącą wynikiem wywołania sieciowego interfejsu API.
Zapis JSON |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Pola | |
---|---|
name |
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, |
metadata |
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). Obiekt zawierający pola dowolnego typu. Dodatkowe pole |
done |
Wartość |
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 |
Wynik błędu operacji w przypadku niepowodzenia lub anulowania. |
response |
Normalna, udana odpowiedź operacji. Jeśli pierwotna metoda nie zwróci żadnych danych o powodzeniu, np. Obiekt zawierający pola dowolnego typu. Dodatkowe pole |
Metody |
|
---|---|
|
Uruchamia asynchroniczne anulowanie długo trwającej operacji. |
|
Usuwa długo trwającą operację. |
|
Pobiera najnowszy stan długo trwającej operacji. |
|
Wyświetla listę operacji pasujących do określonego filtra w żądaniu. |
|
Czeka, aż określona długo trwająca operacja zostanie zakończona, lub osiągnie maksymalny czas oczekiwania, zwracając ostatni stan. |