Kaynak: İşlem
Bu kaynak, bir ağ API çağrısının sonucu olan uzun süreli bir işlemi temsil eder.
JSON gösterimi |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Alanlar | |
---|---|
name |
Sunucu tarafından atanan ad. Bu ad, yalnızca başlangıçta döndüren aynı hizmet içinde benzersizdir. Varsayılan HTTP eşlemesini kullanıyorsanız |
metadata |
İşlemle ilişkili hizmete özgü meta veriler. Genellikle ilerleme bilgileri ve oluşturma zamanı gibi ortak meta veriler içerir. Bazı hizmetler bu tür meta verileri sağlamayabilir. Uzun süren bir işlem döndüren tüm yöntemler, varsa meta veri türünü belgelemelidir. İstediğiniz türde alanlar içeren bir nesne. Ek bir alan |
done |
Değer |
Birleştirme alanı result . İşlem sonucu. error veya geçerli bir response olabilir. done == false ise ne error ne de response ayarlanır. done == true ise error veya response 'den yalnızca biri ayarlanabilir. Bazı hizmetler sonuç vermeyebilir. result yalnızca aşağıdakilerden biri olabilir: |
|
error |
Başarısızlık veya iptal durumunda işlemin hata sonucu. |
response |
İşlemin normal ve başarılı yanıtı. Orijinal yöntem başarıyla tamamlandığında veri döndürmüyorsa (ör. İstediğiniz türde alanlar içeren bir nesne. Ek bir alan |
Yöntemler |
|
---|---|
|
Uzun süren bir işlemde eşzamansız iptal başlatır. |
|
Uzun süreli bir işlemi siler. |
|
Uzun süren bir işlemin en son durumunu alır. |
|
İstekte belirtilen filtreyle eşleşen işlemleri listeler. |
|
Belirtilen uzun süreli işlem tamamlanana veya en fazla belirtilen zaman aşımı süresine ulaşana kadar bekler ve en son durumu döndürür. |