Package google.longrunning

Indeks

Operacje

Zarządza długotrwałymi operacjami za pomocą usługi interfejsu API.

Gdy wykonanie metody interfejsu API zwykle zajmuje dużo czasu, można ją zaprojektować tak, aby zwracała Operation klientowi. Klient może użyć tego interfejsu, aby asynchronicznie otrzymać rzeczywistą odpowiedź, przeprowadzając ankietę zasobów operacji lub przekazując zasób operacji do innego interfejsu API (np. interfejsu Pub/Sub API), aby otrzymać odpowiedź. Każda usługa interfejsu API, która zwraca długotrwałe operacje, powinna implementować interfejs Operations, aby zapewnić klientom spójne wrażenia.

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

Rozpoczyna asynchroniczne anulowanie długotrwałej operacji. Serwer dokłada wszelkich starań, aby anulować operację, ale nie można tego zagwarantować. Jeśli serwer nie obsługuje tej metody, zwraca google.rpc.Code.UNIMPLEMENTED. Klienci mogą użyć Operations.GetOperation lub innych metod, aby sprawdzić, czy anulowanie się powiodło lub czy operacja została zakończona pomimo anulowania. Po anulowaniu operacji nie jest ona usuwana. Zamiast tego staje się operacją z wartością Operation.error i wartością google.rpc.Status.code = 1 odpowiadającą operacji Code.CANCELLED.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/cloud-platform
DeleteOperation

rpc DeleteOperation(DeleteOperationRequest) returns (Empty)

Usuwa długo działającą operację. Ta metoda wskazuje, że klient nie jest już zainteresowany wynikiem operacji. Nie anuluje to operacji. Jeśli serwer nie obsługuje tej metody, zwraca google.rpc.Code.UNIMPLEMENTED.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/cloud-platform
GetOperation

rpc GetOperation(GetOperationRequest) returns (Operation)

Pobiera najnowszy stan długo trwającej operacji. Klienci mogą używać tej metody do sprawdzania wyników operacji w określonych odstępach czasu zalecanych przez usługę interfejsu API.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Uprawnienia

Wymaga tych uprawnień IAM do zasobu name:

  • routeoptimization.operations.get

Więcej informacji znajdziesz w dokumentacji dotyczącej uprawnień.
ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

Wypisuje operacje pasujące do filtra określonego w żądaniu. Jeśli serwer nie obsługuje tej metody, zwraca UNIMPLEMENTED.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/cloud-platform
WaitOperation

rpc WaitOperation(WaitOperationRequest) returns (Operation)

Czeka, aż określona długotrwała operacja zostanie zakończona lub osiągnie maksymalny określony czas oczekiwania, zwracając najnowszy stan. Jeśli operacja została już wykonana, zwracany jest najnowszy stan. Jeśli podany limit czasu jest dłuższy niż domyślny limit czasu HTTP/RPC, jest używany limit czasu HTTP/RPC. Jeśli serwer nie obsługuje tej metody, zwraca wartość google.rpc.Code.UNIMPLEMENTED. Pamiętaj, że ta metoda jest stosowana z możliwie największą dokładnością. Może zwrócić najnowszy stan przed określonym czasem oczekiwania (w tym natychmiast), co oznacza, że nawet natychmiastowa odpowiedź nie gwarantuje, że operacja została wykonana.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/cloud-platform

CancelOperationRequest

Wiadomość z prośbą o Operations.CancelOperation.

Pola
name

string

Nazwa zasobu operacji, który ma zostać anulowany.

DeleteOperationRequest

Wiadomość z prośbą o Operations.DeleteOperation.

Pola
name

string

Nazwa zasobu operacji do usunięcia.

GetOperationRequest

Wiadomość z prośbą o Operations.GetOperation.

Pola
name

string

Nazwa zasobu operacji.

ListOperationsRequest

Wiadomość z prośbą o Operations.ListOperations.

Pola
name

string

Nazwa zasobu nadrzędnego operacji.
filter

string

Standardowy filtr listy.
page_size

int32

Standardowy rozmiar strony listy.
page_token

string

Standardowy token strony listy.

ListOperationsResponse

Wiadomość z odpowiedzią dotyczącą Operations.ListOperations.

Pola
operations[]

Operation

Lista operacji pasujących do określonego w żądaniu filtra.
next_page_token

string

Standardowy token strony List next-page.

Operacja

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

Pola
name

string

Nazwa przypisana przez serwer, która jest niepowtarzalna tylko w ramach tej samej usługi, która ją 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 związane z usługą powiązane z operacją. Zwykle zawiera informacje o postępach i powszechnie używane 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 występuje).
done

bool

Jeśli wartość to false, oznacza to, że operacja jest nadal w toku. Jeśli true, operacja została zakończona, a dostępne jest pole 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, ani error, ani response nie są ustawione. Jeśli done = true, można ustawić dokładnie jedną wartość error lub response. Niektóre usługi mogą nie dostarczyć wyniku. result może być tylko jednym z tych elementów:
error

Status

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

Any

Zwykła odpowiedź operacji po jej pomyślnym wykonaniu. Jeśli pierwotna metoda nie zwraca żadnych danych o sukcesie, np. Delete, odpowiedź to google.protobuf.Empty. Jeśli oryginalna metoda to standardowa Get/Create/Update, odpowiedzią powinna być usługa. W przypadku innych metod odpowiedź powinna mieć typ XxxResponse, gdzie Xxx to nazwa pierwotnej metody. Jeśli np. pierwotna nazwa metody to TakeSnapshot(), wywnioskowany typ odpowiedzi to TakeSnapshotResponse.

WaitOperationRequest

wiadomość z prośbą o Operations.WaitOperation,

Pola
name

string

Nazwa zasobu operacji, na którą ma czekać.
timeout

Duration

Maksymalny czas oczekiwania przed przekroczeniem limitu czasu. Jeśli pozostawisz to pole puste, czas oczekiwania będzie wynosił maksymalnie tyle, ile zezwala na to podstawowy protokół HTTP/RPC. Jeśli określony jest też termin RPC context, zostanie użyty krótszy termin.