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 |
Alanlar | |
---|---|
name |
Sunucu tarafından atanan ad; bu ad, yalnızca onu ilk döndüren hizmette benzersizdir. Varsayılan HTTP eşlemesini kullanıyorsanız |
metadata |
İşlemle ilişkilendirilen hizmete özgü meta veriler. Genellikle ilerleme bilgilerini ve oluşturma zamanı gibi yaygın meta verileri içerir. Bazı hizmetler bu tür meta veriler 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 |
result alanı. error veya geçerli bir response olabilecek işlem sonucu. done == false ise ne error ne de response ayarlanır. done == true ise error veya response değerlerinden tam olarak biri ayarlanabilir. Bazı hizmetler sonucu sağlamayabilir. result şunlardan yalnızca biri olabilir: |
|
error |
Hata veya iptal durumunda işlemin hata sonucu. |
response |
Başarılı olması durumunda işlemin normal yanıtı. Orijinal yöntem, 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ışılacağı 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 yaygın bir dizi mesaj türü vardır. Rastgele türde alanlar içeren bir nesne. |
Yöntemler |
|
---|---|
|
Uzun süreli bir işlemin en son durumunu alır. |