Package google.longrunning

Indeks

Operacje

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

Gdy metoda interfejsu API zwykle trwa bardzo długo, można ją zaprojektować w taki sposób, aby zwracała klientowi Operation. Klient może za pomocą tego interfejsu asynchronicznie otrzymać prawdziwą odpowiedź, odpytując zasób operacji, lub przekazać zasób operacji do innego interfejsu API (np. Pub/Sub API), aby otrzymać odpowiedź. Każda usługa interfejsu API, która zwraca długo trwające operacje, powinna implementować interfejs Operations, aby deweloperzy mogli korzystać ze spójnego środowiska klienta.

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

Rozpoczyna asynchroniczne anulowanie w przypadku długo trwającej operacji. Serwer dokłada wszelkich starań, aby anulować operację, ale powodzenie nie jest gwarantowane. Jeśli serwer nie obsługuje tej metody, zwraca wartość google.rpc.Code.UNIMPLEMENTED. Klienci mogą użyć metody Operations.GetOperation lub innych metod, aby sprawdzić, czy anulowanie się udało lub czy operacja została zakończona pomimo anulowania. Po pomyślnym anulowaniu operacja nie jest usuwana. Zamiast tego staje się operacją z wartością Operation.error i google.rpc.Status.code równą 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 wskazuje, że klient nie jest już zainteresowany wynikiem operacji. Operacja nie zostanie anulowana. 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. Klienty mogą używać tej metody do odpytywania wyników operacji w odstępach czasowych zalecanych przez usługę interfejsu API.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

Wyświetla listę operacji pasujących do określonego filtra w żądaniu. 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 ustawiony limit czasu, zwracając ostatni stan. Jeśli operacja została już wykonana, natychmiast zwracany jest jej ostatni stan. Jeśli określony czas oczekiwania jest dłuższy 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 działa zgodnie z zasadą możliwie najlepszej obsługi. Może zwrócić ostatni stan przed określonym czasem oczekiwania (również natychmiast), co oznacza, że nawet natychmiastowa odpowiedź nie daje gwarancji, że operacja zostanie 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óra ma zostać anulowana.

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 z listą.
page_token

string

Standardowy token strony z listą.

ListOperationsResponse

Odpowiedź na pytanie: Operations.ListOperations.

Pola
operations[]

Operation

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

string

Standardowy token listy następnej strony.

Operacja

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

Pola
name

string

Nazwa przypisana przez serwer, która jest unikalna tylko w obrębie tej samej usługi, która została zwrócona. Jeśli używasz domyślnego mapowania HTTP, nazwa name powinna być nazwą zasobu z końcówką operations/{unique_id}.
metadata

Any

Metadane dotyczące konkretnej usługi, które są powiązane z operacją. Zwykle zawiera on informacje o postępach i typowe metadane, np. czas utworzenia. Niektóre usługi mogą nie udostępniać takich metadanych. Każda metoda, która zwraca długo trwającą operację, powinna udokumentować typ metadanych (jeśli taki istnieje).
done

bool

Jeśli wartość to false, oznacza to, że operacja jest w toku. Jeśli ustawiona jest wartość true, operacja została ukończona i dostępna jest wartość error lub response.
Pole sumy result. Wynik operacji, który może być error lub prawidłową wartością response. Jeśli done == false, nie ustawiono żadnej wartości error ani response. Jeśli done == true, można ustawić dokładnie jedno z tych wartości: error lub response. Niektóre usługi mogą nie zapewniać oczekiwanych rezultatów. result może być tylko jedną z tych wartości:
error

Status

Błąd będący wynikiem operacji w przypadku niepowodzenia lub anulowania.
response

Any

Normalna, udana odpowiedź operacji. Jeśli pierwotna metoda nie zwróci żadnych danych dotyczących powodzenia, np. Delete, odpowiedź to google.protobuf.Empty. Jeśli pierwotna metoda to standardowa metoda Get/Create/Update, odpowiedź powinna być zasobem. 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(), przewidywanym typem odpowiedzi jest TakeSnapshotResponse.

WaitOperationRequest

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

Pola
name

string

Nazwa zasobu operacji, na którym chcesz czekać.
timeout

Duration

Maksymalny czas oczekiwania przed przekroczeniem limitu czasu. Jeśli pozostawisz to pole puste, czas oczekiwania będzie wynosić maksymalnie czas dozwolony przez bazowy protokół HTTP/RPC. Jeśli podasz również termin kontekstu RPC, zostanie użyty krótszy z nich.