REST Resource: projects.databases.operations

Kaynak: İşlem

Bu kaynak, bir ağ API çağrısı sonucunda gerçekleşen uzun süreli bir işlemi temsil eder.

JSON gösterimi
{
  "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.
}
Alanlar
name

string

Sunucu tarafından atanan ad; bu ad, yalnızca sunucuyu ilk döndüren hizmette benzersizdir. Varsayılan HTTP eşlemesini kullanıyorsanız name, operations/{unique_id} ile biten bir kaynak adı olmalıdır.

metadata

object

İşlemle ilişkilendirilen hizmete özgü meta veriler. Bu veriler genellikle ilerleme bilgilerinin yanı sıra oluşturma zamanı gibi genel meta verileri içerir. Bazı hizmetler bu tür meta verileri sağlamayabilir. Uzun süreli bir işlem döndüren yöntemler, varsa meta veri türünü belgelemelidir.

Rastgele türde alanlar içeren bir nesne. "@type" adlı ek alan, türü tanımlayan bir URI içerir. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.

done

boolean

Değer false ise işlemin devam ettiği anlamına gelir. true ise işlem tamamlanmıştır ve error veya response kullanılabilir.

Birleştirme alanı result. İşlemin sonucu. Bu değer, error veya geçerli bir response olabilir. done == false ise ne error ne de response ayarlanır. done == true ise tam olarak error veya response değerlerinden biri ayarlanabilir. Bazı hizmetler sonucu sağlamayabilir. result şunlardan yalnızca biri olabilir:
error

object (Status)

Hata veya iptal durumunda işlemin hata sonucu.

response

object

İşlemin normal, başarılı yanıtı. Orijinal yöntem başarılı olduğuna ilişkin hiçbir veri döndürmediyse yanıt (ör. Delete) google.protobuf.Empty olur. Orijinal yöntem standart Get/Create/Update ise yanıt kaynak olmalıdır. Diğer yöntemler için yanıtın türü XxxResponse olmalıdır. Burada Xxx, orijinal yöntemin adıdır. Örneğin, orijinal yöntemin adı TakeSnapshot() ise tahmin edilen yanıt türü TakeSnapshotResponse olur.

Rastgele türde alanlar içeren bir nesne. "@type" adlı ek alan, türü tanımlayan bir URI içerir. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.

Yöntemler

cancel

Uzun süreli bir işlemde eşzamansız iptali başlatır.

delete

Uzun süreli bir işlemi siler.

get

Uzun süreli bir işlemin en son durumunu alır.

list

İstekte belirtilen filtreyle eşleşen işlemleri listeler.