Zasób: operacja
Ten zasób reprezentuje długo trwającą operację, która jest 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 unikalna tylko w obrębie tej samej usługi, która została zwrócona. Jeśli używasz domyślnego mapowania HTTP, nazwa |
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 |
Jeśli wartość to |
Pole sumy result . Wynik operacji, który może być error lub prawidłową wartością response . Jeśli done == false , nie ustawiono żadnej wartości 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 rezultatów. result może być tylko jedną z tych wartości: |
|
error |
Błąd będący wynikiem operacji w przypadku niepowodzenia lub anulowania. |
response |
Normalna, udana odpowiedź operacji. Jeśli pierwotna metoda nie zwróci żadnych danych dotyczących powodzenia, np. Obiekt zawierający pola dowolnego typu. Dodatkowe pole |
Metody |
|
---|---|
|
Rozpoczyna asynchroniczne anulowanie w przypadku 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ługotrwała operacja zostanie zakończona lub osiągnie ustawiony limit czasu, zwracając ostatni stan. |