Package google.longrunning

Indeks

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ę

rpc CancelOperation( CancelOperationRequest ) returns ( Empty )

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 google.rpc.Code.UNIMPLEMENTED . Klienci mogą użyć Operations.GetOperation lub innych metod, aby sprawdzić, czy anulowanie powiodło się lub czy operacja została ukończona pomimo anulowania. W przypadku pomyślnego anulowania operacja nie zostanie usunięta; zamiast tego staje się operacją z wartością Operation.error z kodem google.rpc.Status.code o wartości 1, odpowiadającym Code.CANCELLED .

Zakresy uprawnień

Wymaga jednego z następujących zakresów OAuth:

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

Aby uzyskać więcej informacji, zobacz Omówienie uwierzytelniania .

Usuń operację

rpc DeleteOperation( DeleteOperationRequest ) returns ( Empty )

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 google.rpc.Code.UNIMPLEMENTED .

Zakresy uprawnień

Wymaga jednego z następujących zakresów OAuth:

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

Aby uzyskać więcej informacji, zobacz Omówienie uwierzytelniania .

Pobierz operację

rpc GetOperation( GetOperationRequest ) returns ( Operation )

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.

Zakresy uprawnień

Wymaga jednego z następujących zakresów OAuth:

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

Aby uzyskać więcej informacji, zobacz Omówienie uwierzytelniania .

Lista operacji

rpc ListOperations( ListOperationsRequest ) returns ( ListOperationsResponse )

Wyświetla listę operacji pasujących do określonego filtru w żądaniu. Jeśli serwer nie obsługuje tej metody, zwraca UNIMPLEMENTED .

Zakresy uprawnień

Wymaga jednego z następujących zakresów OAuth:

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

Aby uzyskać więcej informacji, zobacz Omówienie uwierzytelniania .

Czekaj, operacja

rpc WaitOperation( WaitOperationRequest ) returns ( Operation )

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 google.rpc.Code.UNIMPLEMENTED . Należy pamiętać, że ta metoda opiera się na zasadzie najlepszego wysiłku. Może zwrócić najnowszy stan przed określonym limitem czasu (w tym natychmiast), co oznacza, że ​​nawet natychmiastowa odpowiedź nie gwarantuje wykonania operacji.

Zakresy uprawnień

Wymaga jednego z następujących zakresów OAuth:

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

Aby uzyskać więcej informacji, zobacz Omówienie uwierzytelniania .

Anuluj żądanie operacji

Komunikat żądania dla Operations.CancelOperation .

Pola
name

string

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

Usuń żądanie operacji

Komunikat żądania dla Operations.DeleteOperation .

Pola
name

string

Nazwa zasobu operacyjnego, który ma zostać usunięty.

Pobierz żądanie operacji

Komunikat żądania dla Operations.GetOperation .

Pola
name

string

Nazwa zasobu operacyjnego.

Żądanie ListOperations

Komunikat żądania dla 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.

Lista operacji — odpowiedź

Komunikat 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.

Operacja

Ten zasób reprezentuje długotrwałą operację będącą wynikiem wywołania sieciowego interfejsu API.

Pola
name

string

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, name powinna być nazwa zasobu kończąca się na operations/{unique_id} .

metadata

Any

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

bool

Jeśli wartość to false , oznacza to, że operacja jest nadal w toku. Jeśli true , operacja zostanie zakończona i dostępny będzie error lub response .

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

Status

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

response

Any

Normalna, pomyślna reakcja operacji. Jeśli oryginalna metoda nie zwróci żadnych danych o powodzeniu, np. Delete , odpowiedzią będzie google.protobuf.Empty . Jeśli oryginalną metodą jest standardowa metoda Get / Create / Update , odpowiedzią powinien być zasób. W przypadku innych metod odpowiedź powinna mieć typ XxxResponse , gdzie Xxx to oryginalna nazwa metody. Na przykład, jeśli oryginalna nazwa metody to TakeSnapshot() , wywnioskowany typ odpowiedzi to TakeSnapshotResponse .

Żądanie oczekiwania na operację

Komunikat żądania dla Operations.WaitOperation .

Pola
name

string

Nazwa zasobu operacyjnego, na który należy czekać.

timeout

Duration

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.