REST Resource: projects.operations

Zasób: Operation

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

Zapis JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of mutually exclusive fields.
}
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

object

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

Obiekt zawierający pola dowolnego typu. Dodatkowe pole "@type" zawiera identyfikator URI określający typ. Przykład: { "id": 1234, "@type": "types.example.com/standard/id" }
done

boolean

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.
Wynik operacji, który może być wartością error lub prawidłową wartością response. Jeśli done == false, nie jest ustawiona ani wartość 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. Poniżej znajduje się lista pól, które się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
error

object (Status)

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

object

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.

Obiekt zawierający pola dowolnego typu. Dodatkowe pole "@type" zawiera identyfikator URI określający typ. Przykład: { "id": 1234, "@type": "types.example.com/standard/id" }.
Koniec pól, które się wykluczają.

Metody

cancel

 Rozpoczyna asynchroniczne anulowanie długo trwającej operacji.

delete

 Usuwa długo trwającą operację.

get

 Pobiera najnowszy stan długo trwającej operacji.

list

 Wyświetla listę operacji pasujących do określonego w żądaniu filtra.

wait

 Czeka, aż określona długo trwająca operacja zostanie zakończona lub osiągnie maksymalny określony limit czasu, i zwraca najnowszy stan.