Package google.longrunning

Indeks

Operacja

Ten zasób reprezentuje długo trwającą operację, która jest wynikiem wywołania interfejsu API sieci.

Pola
name

string

Nazwa przypisana przez serwer, która jest unikalna tylko w ramach tej samej usługi, która ją pierwotnie zwraca. Jeśli używasz domyślnego mapowania HTTP, name powinna być nazwą zasobu kończącą się na operations/{unique_id}.
metadata

Any

Metadane specyficzne dla usługi powiązane z operacją. Zwykle zawiera informacje o postępach i metadane, takie jak czas utworzenia. Niektóre usługi mogą nie udostępniać takich metadanych. Każda metoda, która zwraca operację długotrwałą, powinna zawierać dokumentację typu metadanych (jeśli występuje).
done

bool

Jeśli wartość to false, oznacza to, że operacja jest w toku. Jeśli true, operacja została ukończona i dostępne są wartości error lub response.
Pole unii result. Wynik operacji, który może być wartością error lub prawidłową wartością response. Jeśli done == false, nie ustawia się ani error, ani response. Jeśli done == true, ustawiona jest dokładnie jedna z wartości error lub response. result może mieć tylko jedną z tych wartości:
error

Status

Wynik błędu operacji w przypadku niepowodzenia lub anulowania.
response

Any

Normalna odpowiedź operacji w przypadku powodzenia. Jeśli oryginalna metoda nie zwraca danych w przypadku powodzenia, np. Delete, odpowiedź to google.protobuf.Empty. Jeśli oryginalna metoda to standardowa metoda Get/Create/Update, odpowiedź powinna być zasobem. W przypadku innych metod odpowiedź powinna mieć typ XxxResponse, gdzie Xxx to oryginalna nazwa metody. Jeśli na przykład oryginalna nazwa metody to TakeSnapshot(), wywnioskowany typ odpowiedzi to TakeSnapshotResponse.