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 |
Stan
Typ Status
definiuje model błędu logicznego, który jest odpowiedni dla różnych środowisk programowania, w tym interfejsów API REST i interfejsów API RPC. Jest używany przez gRPC. Każdy komunikat Status
zawiera 3 rodzaje danych: kod błędu, komunikat o błędzie i szczegóły błędu.
Więcej informacji o tym modelu błędu i o tym, jak z nim korzystać, znajdziesz w dokumencie API Design Guide (w języku angielskim).
Zapis JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Pola | |
---|---|
code |
Kod stanu, który powinien być wartością wyliczeniową |
message |
Komunikat o błędzie widoczny dla dewelopera w języku angielskim. Każdy komunikat o błędzie widoczny dla użytkownika powinien być zlokalizowany i wysyłany w polu |
details[] |
Lista komunikatów zawierających szczegółowe informacje o błędzie. Istnieje wspólny zestaw typów wiadomości używanych przez interfejsy API. 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. |