Zasób: operacja
Ten zasób reprezentuje długotrwałą 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 pierwotnie została zwrócona. Jeśli używasz domyślnego mapowania HTTP, pole |
metadata |
Metadane specyficzne dla usługi powiązane z operacją. Zwykle zawiera on informacje o postępach 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 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órym może być error lub prawidłowy response . Jeśli done == false , nie ustawiono error ani response . Jeśli done == true , można ustawić dokładnie jedną z tych wartości error lub response . Niektóre usługi mogą nie dawać oczekiwanych rezultató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 |
|
---|---|
|
Rozpoczyna anulowanie asynchronicznej długo trwającej operacji. |
|
Usuwa długo trwającą operację. |
|
Pobiera najnowszy stan długo trwającej operacji. |
|
Wyświetla listę operacji, które pasują do określonego filtra w żądaniu. |
|
Czekam, aż określona długo trwająca operacja zostanie wykonana lub osiągnie określony czas oczekiwania, zwracając najnowszy stan. |