Package google.longrunning

Indeks

Operacja

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

Pola
name

string

Nazwa przypisana do serwera, która jest unikalna w tej samej usłudze, która została zwrócona. Jeśli używasz domyślnego mapowania HTTP, name powinna być nazwą zasobu kończącą się operations/{unique_id}.
metadata

Any

Metadane dotyczące 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 dostarczać takich metadanych. Każda metoda, która zwraca długotrwałą operację, powinna udokumentować typ metadanych (jeśli istnieje).
done

bool

Jeśli wartość to false, oznacza to, że operacja jest w toku. Jeśli operacja true została zakończona, operacja error i response jest dostępna.
Pole związkowe result. Wynik operacji może być wartością error lub prawidłową wartością response. Jeśli done == false, nie jest ustawiony żaden error ani response. Jeśli done == true, ustawiono dokładnie jedną wartość 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 pierwotna metoda nie zwraca żadnych danych dotyczących powodzenia, takich jak Delete, odpowiedź to google.protobuf.Empty. Jeśli pierwotna metoda to Get/Create/Update, odpowiedź powinna zawierać zasób. W przypadku innych metod odpowiedź powinna mieć typ XxxResponse, gdzie Xxx to pierwotna nazwa metody. Jeśli na przykład pierwotna nazwa metody to TakeSnapshot(), wnioskowana odpowiedź to TakeSnapshotResponse.