Zasób: Operacja
Ten zasób reprezentuje długotrwałą operację będącą wynikiem wywołania sieciowego interfejsu API.
Polem response
operacji będzie UploadReleaseResponse .
Reprezentacja JSON |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Pola | |
---|---|
name | Nazwa przypisana przez serwer, która jest unikalna tylko w ramach tej samej usługi, która pierwotnie ją zwróciła. Jeśli używasz domyślnego mapowania HTTP, |
metadata | Metadane specyficzne dla usługi powiązane z operacją. Zwykle zawiera informacje o postępie 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 dokumentować typ metadanych, jeśli taki istnieje. Obiekt zawierający pola dowolnego typu. Dodatkowe pole |
done | Jeśli wartość to |
Wynik result Unii. Wynik operacji, który może być error lub prawidłową response . Jeśli done == false , nie zostanie ustawiony ani error , ani response . Jeśli done == true , można ustawić dokładnie jeden error lub response . Niektóre usługi mogą nie zapewniać wyniku. result może być tylko jeden z następujących: | |
error | Wynik błędu operacji w przypadku niepowodzenia lub anulowania. |
response | Normalna reakcja operacji w przypadku powodzenia. W tym przypadku będzie to UploadReleaseResponse . |
Status
Typ Status
definiuje model błędów logicznych odpowiedni dla różnych środowisk programistycznych, w tym interfejsów API REST i interfejsów API RPC. Jest używany przez gRPC . Każdy komunikat Status
zawiera trzy elementy danych: kod błędu, komunikat o błędzie i szczegóły błędu.
Więcej informacji na temat tego modelu błędów i sposobu pracy z nim można znaleźć w Przewodniku projektowania interfejsu API .
Reprezentacja 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 skierowany do programisty, który powinien być w języku angielskim. Każdy komunikat o błędzie wyświetlany użytkownikowi powinien zostać zlokalizowany i przesłany w polu |
details[] | Lista komunikatów zawierających szczegóły błędu. Istnieje wspólny zestaw typów komunikatów, z których mogą korzystać interfejsy API. Obiekt zawierający pola dowolnego typu. Dodatkowe pole |
Metody | |
---|---|
| Pobiera najnowszy stan długotrwałej operacji. |