Package google.longrunning

Indeks

Operacje

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

Jeśli wykonanie metody API zwykle trwa długo, można ją zaprojektować tak, aby zwracała klientowi wartość Operation. Klient może używać tego interfejsu do asynchronicznego odbierania rzeczywistej odpowiedzi przez sprawdzanie zasobu operacji lub przekazywanie zasobu operacji do innego interfejsu API (np. Pub/Sub API) w celu otrzymania odpowiedzi. Każda usługa API, która zwraca długo trwające operacje, powinna implementować interfejs Operations, aby programiści mogli korzystać z jednolitego środowiska klienta.

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

(Obecnie nieobsługiwane) Rozpoczyna asynchroniczne anulowanie długo trwającej operacji.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc DeleteOperation(DeleteOperationRequest) returns (Empty)

(Obecnie nieobsługiwane) Usuwa długo trwającą operację.

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 uprawnień.
ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

(Obecnie nieobsługiwane) Wyświetla listę operacji, które pasują do określonego w żądaniu filtra.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc WaitOperation(WaitOperationRequest) returns (Operation)

(Obecnie nieobsługiwane) Czeka, aż określona długo trwająca operacja zostanie zakończona lub osiągnie maksymalny określony limit czasu, zwracając najnowszy stan.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

CancelOperationRequest

Komunikat żądania dla Operations.CancelOperation.

Pola
name

string

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

DeleteOperationRequest

Komunikat żądania dla Operations.DeleteOperation.

Pola
name

string

Nazwa zasobu operacji, która ma zostać usunięta.

GetOperationRequest

Komunikat żądania dla Operations.GetOperation.

Pola
name

string

Nazwa zasobu operacji.

ListOperationsRequest

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

bool

Jeśli ustawisz wartość true, operacje, które są dostępne, zostaną zwrócone w normalny sposób, a te, które są niedostępne, zostaną zwrócone w polu ListOperationsResponse.unreachable.

Może to być tylko true podczas odczytywania w zbiorach. Na przykład, gdy parent jest ustawiony na "projects/example/locations/-".

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

ListOperationsResponse

Komunikat odpowiedzi dla Operations.ListOperations.

Pola
operations[]

Operation

Lista operacji, które pasują do określonego w żądaniu filtra.
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 w zbiorach. Na przykład podczas próby wyświetlenia listy wszystkich zasobów we wszystkich obsługiwanych lokalizacjach.

Operation

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 długo trwającą operację, 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

Komunikat żądania dla 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 pozostawisz to pole puste, czas oczekiwania będzie maksymalnie równy czasowi dozwolonemu przez protokół HTTP/RPC. Jeśli określono też limit czasu kontekstu RPC, zostanie użyty krótszy z tych limitów.