Package google.longrunning

Indeks

Operacje

Zarządza długo trwającymi operacjami za pomocą usługi API.

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

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

Rozpoczyna asynchroniczne anulowanie długotrwałej operacji. Serwer podejmuje próbę anulowania operacji, ale nie gwarantuje, że się to uda. Jeśli serwer nie obsługuje tej metody, zwraca wartość google.rpc.Code.UNIMPLEMENTED. Klienci mogą używać metody Operations.GetOperation lub innych metod, aby sprawdzić, czy anulowanie się powiodło lub czy operacja została zakończona pomimo anulowania. Po pomyślnym anulowaniu operacja nie jest usuwana, tylko zmienia się w operację z wartością Operation.error i wartością google.rpc.Status.code równą 1, co odpowiada 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 trwającą operację. Ta metoda oznacza, że klient nie jest już zainteresowany wynikiem operacji. Nie anuluje to operacji. Jeśli serwer nie obsługuje tej metody, zwraca wartość 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 wyniku operacji w interwałach zalecanych przez usługę API.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Wymaga tych uprawnień IAM w zasobie name:

  • routeoptimization.operations.get

Więcej informacji znajdziesz w dokumentacji IAM.
ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

Wyświetla listę operacji zgodnych z określonym w żądaniu filtrem. Jeśli serwer nie obsługuje tej metody, zwraca wartość 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 maksymalnie określony limit czasu, i zwraca najnowszy stan. Jeśli operacja została już wykonana, zwracany jest natychmiast jej 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 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 upływem określonego limitu czasu (w tym natychmiast), co oznacza, że nawet natychmiastowa odpowiedź nie gwarantuje zakończenia operacji.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

CancelOperationRequest

Wiadomość z prośbą o dostęp do urządzenia Operations.CancelOperation.

Pola
name

string

Nazwa zasobu operacji, która ma zostać anulowana.

DeleteOperationRequest

Wiadomość z prośbą o dostęp do urządzenia Operations.DeleteOperation.

Pola
name

string

Nazwa zasobu operacji do usunięcia.

GetOperationRequest

Wiadomość z prośbą o dostęp do urządzenia Operations.GetOperation.

Pola
name

string

Nazwa zasobu operacji.

ListOperationsRequest

Wiadomość z prośbą o dostęp do urządzenia 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 z listą.
return_partial_success

bool

Gdy ta wartość jest ustawiona na true, operacje, które są dostępne, są zwracane w normalny sposób, a operacje niedostępne są zwracane w polu [ListOperationsResponse.unreachable].

Wartość tego parametru może być tylko true w przypadku odczytu z wielu kolekcji, np. gdy parametr parent ma wartość "projects/example/locations/-".

To pole nie jest domyślnie obsługiwane i jeśli zostanie ustawione, spowoduje błąd UNIMPLEMENTED, chyba że w dokumentacji dotyczącej konkretnej usługi lub produktu wyraźnie określono inaczej.

ListOperationsResponse

Wiadomość z odpowiedzią dla Operations.ListOperations.

Pola
operations[]

Operation

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

string

Standardowy token następnej strony listy.
unreachable[]

string

Lista nieuporządkowana. Niedostępne zasoby. Wypełniane, gdy żądanie ustawia ListOperationsRequest.return_partial_success i odczytuje dane z kolekcji, np. podczas próby wyświetlenia listy wszystkich zasobów we wszystkich obsługiwanych lokalizacjach.

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 typowe 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 zbiorcze result. Wynik operacji, który może być wartością error lub prawidłową wartością response. Jeśli done == false, nie ustawiono ani error, ani response. Jeśli done == true, można ustawić tylko jedną z wartości error lub response. Niektóre usługi mogą nie zwracać wyniku. 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 np. oryginalna nazwa metody to TakeSnapshot(), wywnioskowany typ odpowiedzi to TakeSnapshotResponse.

WaitOperationRequest

Wiadomość z prośbą o dostęp do urządzenia Operations.WaitOperation.

Pola
name

string

Nazwa zasobu operacji, na którą należy poczekać.
timeout

Duration

Maksymalny czas oczekiwania przed przekroczeniem limitu czasu. Jeśli to pole pozostanie puste, czas oczekiwania będzie maksymalnie taki, jaki jest dozwolony przez protokół HTTP/RPC. Jeśli określono też termin RPC, zostanie użyty krótszy z nich.