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 |
Alanlar | |
---|---|
name |
Sunucu tarafından atanan ad; bu ad, yalnızca sunucuyu ilk döndüren hizmette benzersizdir. Varsayılan HTTP eşlemesini kullanıyorsanız |
metadata |
İş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. |
done |
Değer |
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 |
Hata veya iptal durumunda işlemin hata sonucu. |
response |
İş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. Rastgele türde alanlar içeren bir nesne. |
Durum
Status
türü, REST API'ler ve RPC API'leri dahil olmak üzere farklı programlama ortamları için uygun bir mantıksal hata modeli tanımlar. gRPC tarafından kullanılır. Her Status
mesajı üç veri parçası içerir: hata kodu, hata mesajı ve hata ayrıntıları.
Bu hata modeli ve modelle nasıl çalışabileceğiniz hakkında daha fazla bilgiyi API Tasarım Kılavuzu'nda bulabilirsiniz.
JSON gösterimi |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Alanlar | |
---|---|
code |
|
message |
Geliştiricinin karşılaştığı İngilizce hata mesajı. Kullanıcılara yönelik tüm hata mesajları yerelleştirilip |
details[] |
Hata ayrıntılarını içeren mesajların listesi. API'lerin kullanabileceği bir dizi yaygın mesaj türü vardır. Rastgele türde alanlar içeren bir nesne. |