الموارد: العملية
يمثل هذا المورد عملية طويلة الأمد نتيجة لاستدعاء واجهة برمجة تطبيقات الشبكة.
سيكون حقل response
للعملية هو UploadReleaseResponse .
تمثيل جيسون |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
مجالات | |
---|---|
name | الاسم المخصص للخادم، والذي يكون فريدًا فقط داخل نفس الخدمة التي تقوم بإرجاعه في الأصل. إذا كنت تستخدم تعيين HTTP الافتراضي، فيجب أن يكون |
metadata | بيانات التعريف الخاصة بالخدمة المرتبطة بالعملية. ويحتوي عادةً على معلومات التقدم وبيانات التعريف الشائعة مثل وقت الإنشاء. قد لا توفر بعض الخدمات مثل هذه البيانات التعريفية. يجب أن تقوم أي طريقة تقوم بإرجاع عملية طويلة الأمد بتوثيق نوع بيانات التعريف، إن وجدت. كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي |
done | إذا كانت القيمة |
result ميدان الاتحاد . نتيجة العملية، والتي يمكن أن تكون إما error أو response صالحة. إذا done == false ، فلن يتم تعيين error أو response . إذا done == true ، فقد يتم تعيين error أو response واحدة بالضبط. قد لا توفر بعض الخدمات النتيجة. يمكن أن تكون result واحدة فقط مما يلي: | |
error | نتيجة الخطأ للعملية في حالة الفشل أو الإلغاء. |
response | الاستجابة الطبيعية للعملية في حالة نجاحها. في هذه الحالة سيكون UploadReleaseResponse . |
حالة
يحدد نوع Status
نموذج خطأ منطقي مناسب لبيئات برمجة مختلفة، بما في ذلك واجهات برمجة تطبيقات REST وواجهات برمجة تطبيقات RPC. يتم استخدامه بواسطة gRPC . تحتوي كل رسالة Status
على ثلاث أجزاء من البيانات: رمز الخطأ، ورسالة الخطأ، وتفاصيل الخطأ.
يمكنك معرفة المزيد حول نموذج الخطأ هذا وكيفية التعامل معه في دليل تصميم واجهة برمجة التطبيقات (API Design Guide ).
تمثيل جيسون |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
مجالات | |
---|---|
code | رمز الحالة، والذي ينبغي أن يكون قيمة تعداد لـ |
message | رسالة خطأ تواجه المطور، والتي يجب أن تكون باللغة الإنجليزية. يجب ترجمة أي رسالة خطأ تواجه المستخدم وإرسالها في الحقل |
details[] | قائمة الرسائل التي تحمل تفاصيل الخطأ. توجد مجموعة شائعة من أنواع الرسائل التي يمكن لواجهات برمجة التطبيقات استخدامها. كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي |
طُرق | |
---|---|
| يحصل على أحدث حالة لعملية طويلة الأمد. |