Zasób: operacja
Ten zasób reprezentuje długotrwałą operację, która jest wynikiem wywołania interfejsu API sieci.
Zapis JSON |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Pola | |
---|---|
name |
Nazwa przypisana przez serwer, która jest unikalna w obrębie tej samej usługi, którą pierwotnie zwracała. Jeśli używasz domyślnego mapowania HTTP, właściwość |
metadata |
To pole będzie zawierać obiekt Obiekt zawierający pola dowolnego typu. Dodatkowe pole |
done |
Wartość |
Pole sumy: result . Wynik operacji może być error lub prawidłowy response . Jeśli done == false , nie jest ustawiona wartość error ani response . Jeśli done == true , można ustawić dokładnie jedną wartość error lub response . Niektóre usługi mogą nie zwracać wyników. result może mieć tylko jedną z tych wartości: |
|
error |
To pole nie zostanie ustawione, jeśli operacja zostanie utworzona przez |
response |
To pole będzie zawierać obiekt Obiekt zawierający pola dowolnego typu. Dodatkowe pole |
Stan
Typ Status
określa logiczny model błędu odpowiedni dla różnych środowisk programowania, w tym interfejsów API REST i interfejsów RPC. Używa go gRPC. Każda wiadomość Status
zawiera 3 elementy: kod błędu, komunikat o błędzie i szczegóły błędu.
Więcej informacji o tym modelu błędu i sposobie jego wykorzystania znajdziesz w przewodniku po interfejsie API.
Zapis JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Pola | |
---|---|
code |
Kod stanu, który powinien mieć wartość |
message |
Komunikat o błędzie wyświetlany deweloperowi, który powinien być w języku angielskim. Komunikat o błędzie widoczny dla użytkownika powinien być zlokalizowany i wysłany w polu |
details[] |
Lista komunikatów zawierających szczegóły błędu. Istnieje wspólny zestaw typów wiadomości do użycia przez interfejsy API. Obiekt zawierający pola dowolnego typu. Dodatkowe pole |
Metody |
|
---|---|
|
Pobiera najnowszy stan długo trwającej operacji. |