يمثل هذا المورد عملية طويلة الأمد ناتجة عن طلب بيانات من واجهة برمجة تطبيقات الشبكة.
تمثيل JSON |
---|
{ "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 |
الاستجابة العادية والناجحة للعملية. إذا لم تعرض الطريقة الأصلية أي بيانات عن النجاح، مثل يشير ذلك المصطلح إلى كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي |
الحالة
يحدد النوع Status
نموذج خطأ منطقي مناسبًا لبيئات البرمجة المختلفة، بما في ذلك واجهات برمجة تطبيقات REST وواجهات برمجة التطبيقات RPC. ويتم استخدامها من قِبل gRPC. تحتوي كل رسالة Status
على ثلاث بيانات: رمز الخطأ ورسالة الخطأ وتفاصيل الخطأ.
يمكنك معرفة المزيد حول نموذج الخطأ هذا وكيفية التعامل معه في دليل تصميم واجهة برمجة التطبيقات.
تمثيل JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
الحقول | |
---|---|
code |
تمثّل هذه السمة رمز الحالة، ويجب أن تكون قيمة التعداد |
message |
رسالة خطأ موجَّهة للمطوِّر، يجب أن تكون باللغة الإنجليزية. يجب ترجمة أي رسالة خطأ موجَّهة للمستخدمين وإرسالها في الحقل |
details[] |
قائمة بالرسائل التي تحتوي على تفاصيل الخطأ. تتوفّر مجموعة شائعة من أنواع الرسائل التي يمكن أن تستخدمها واجهات برمجة التطبيقات. يشير ذلك المصطلح إلى كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي |