Indeks
-
Operations
(interfejs) -
CancelOperationRequest
(wiadomość) -
DeleteOperationRequest
(wiadomość) -
GetOperationRequest
(wiadomość) -
ListOperationsRequest
(wiadomość) -
ListOperationsResponse
(wiadomość) -
Operation
(wiadomość) -
WaitOperationRequest
(wiadomość)
Operacje
Zarządza długotrwałymi operacjami za pomocą usługi API.
Gdy wykonanie metody API zwykle zajmuje dużo czasu, można ją zaprojektować tak, aby zwracała Operation
do klienta, a klient może użyć tego interfejsu do asynchronicznego otrzymania rzeczywistej odpowiedzi poprzez odpytywanie zasobu operacyjnego lub przekazać zasób operacyjny do innego interfejsu API ( takie jak API Pub/Sub), aby otrzymać odpowiedź. Każda usługa API, która zwraca długotrwałe operacje, powinna implementować interfejs Operations
, aby programiści mogli zapewnić spójne środowisko klienta.
Anuluj operację |
---|
Rozpoczyna anulowanie asynchroniczne w przypadku długotrwałej operacji. Serwer dokłada wszelkich starań, aby anulować operację, ale nie gwarantuje się powodzenia. Jeśli serwer nie obsługuje tej metody, zwraca
|
Usuń operację |
---|
Usuwa długotrwałą operację. Metoda ta wskazuje, że klienta nie interesuje już wynik operacji. Nie anuluje operacji. Jeśli serwer nie obsługuje tej metody, zwraca
|
Pobierz operację |
---|
Pobiera najnowszy stan długotrwałej operacji. Klienci mogą używać tej metody do odpytywania wyników operacji w odstępach czasu zalecanych przez usługę API.
|
Lista operacji |
---|
Wyświetla listę operacji pasujących do określonego filtru w żądaniu. Jeśli serwer nie obsługuje tej metody, zwraca
|
Czekaj, operacja |
---|
Czeka, aż określona długotrwała operacja zostanie wykonana lub osiągnie co najwyżej określony limit czasu, zwracając najnowszy stan. Jeśli operacja została już wykonana, natychmiast zwracany jest najnowszy stan. Jeśli określony limit czasu jest większy niż domyślny limit czasu HTTP/RPC, używany jest limit czasu HTTP/RPC. Jeśli serwer nie obsługuje tej metody, zwraca
|
Anuluj żądanie operacji
Komunikat żądania dla Operations.CancelOperation
.
Pola | |
---|---|
name | Nazwa zasobu operacji, który ma zostać anulowany. |
Usuń żądanie operacji
Komunikat żądania dla Operations.DeleteOperation
.
Pola | |
---|---|
name | Nazwa zasobu operacyjnego, który ma zostać usunięty. |
Pobierz żądanie operacji
Komunikat żądania dla Operations.GetOperation
.
Pola | |
---|---|
name | Nazwa zasobu operacyjnego. |
Żądanie ListOperations
Komunikat żądania dla Operations.ListOperations
.
Pola | |
---|---|
name | Nazwa zasobu nadrzędnego operacji. |
filter | Standardowy filtr listy. |
page_size | Standardowy rozmiar strony listy. |
page_token | Standardowy token strony listy. |
Lista operacji — odpowiedź
Komunikat odpowiedzi dla Operations.ListOperations
.
Pola | |
---|---|
operations[] | Lista operacji pasujących do filtra określonego w żądaniu. |
next_page_token | Standardowy token następnej strony listy. |
Operacja
Ten zasób reprezentuje długotrwałą operację będącą wynikiem wywołania sieciowego interfejsu API.
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. |
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, pomyślna reakcja operacji. Jeśli oryginalna metoda nie zwróci żadnych danych o powodzeniu, np. |
Żądanie oczekiwania na operację
Komunikat żądania dla Operations.WaitOperation
.
Pola | |
---|---|
name | Nazwa zasobu operacyjnego, na który należy czekać. |
timeout | Maksymalny czas oczekiwania przed upływem limitu czasu. Jeśli pozostawisz puste, oczekiwanie będzie trwało maksymalnie przez czas dozwolony przez podstawowy protokół HTTP/RPC. Jeżeli określono również termin ostateczny kontekstu RPC, zastosowany zostanie krótszy. |