REST Resource: projects.databases.operations

Zasób: operacja

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

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

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
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

object

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

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

object (Status)

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

object

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.

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" }.

Metody

cancel

 Rozpoczyna asynchroniczne anulowanie w przypadku 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 filtra w żądaniu.