Kaynak: Operasyon
Bu kaynak, bir ağ API çağrısının sonucu olan uzun süreli bir işlemi temsil eder.
İşlemin response
alanı UploadReleaseResponse olacaktır.
JSON gösterimi |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Alanlar | |
---|---|
name | Yalnızca orijinal olarak onu döndüren hizmet içinde benzersiz olan, sunucu tarafından atanan ad. Varsayılan HTTP eşlemesini kullanırsanız |
metadata | İşlemle ilişkili hizmete özgü meta veriler. Genellikle ilerleme bilgilerini ve oluşturma zamanı gibi ortak meta verileri içerir. Bazı hizmetler bu tür meta verileri sağlamayabilir. Uzun süren bir işlemi döndüren herhangi bir yöntem, varsa meta veri türünü belgelemelidir. Rastgele türde alanlar içeren bir nesne. Ek bir |
done | Değer |
Birleşim alanı result . Bir error ya da geçerli bir response olabilecek işlem sonucu. Eğer done == false ne error ne de response ayarlanır. Eğer done == true , tam olarak bir error veya response ayarlanabilir. Bazı hizmetler sonuç vermeyebilir. result aşağıdakilerden yalnızca biri olabilir: | |
error | Arıza veya iptal durumunda işlemin hata sonucu. |
response | Başarılı olması durumunda operasyonun normal tepkisi. Bu durumda bir UploadReleaseResponse olacaktır. |
Durum
Status
türü, REST API'leri ve RPC API'leri dahil olmak üzere farklı programlama ortamlarına uygun bir mantıksal hata modeli tanımlar. GRPC tarafından kullanılır. Her Status
mesajı üç parça veri içerir: hata kodu, hata mesajı ve hata ayrıntıları.
Bu hata modeli ve bununla 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 | İngilizce olması gereken, geliştiricinin karşılaştığı bir hata mesajı. Kullanıcının karşılaştığı herhangi bir hata mesajı yerelleştirilip |
details[] | Hata ayrıntılarını taşıyan mesajların listesi. API'lerin kullanabileceği ortak bir mesaj türleri kümesi vardır. Rastgele türde alanlar içeren bir nesne. Ek bir |
Yöntemler | |
---|---|
| Uzun süren bir işlemin en son durumunu alır. |