المرجع: العملية
يمثّل هذا المورد عملية طويلة الأمد ناتجة عن طلب بيانات من واجهة برمجة التطبيقات للشبكة.
تمثيل 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[] |
قائمة بالرسائل التي تتضمّن تفاصيل الخطأ. وهناك مجموعة شائعة من أنواع الرسائل التي يمكن لواجهات برمجة التطبيقات استخدامها. كائن يحتوي على حقول من نوع عشوائي يحتوي الحقل الإضافي |
الطُرق |
|
---|---|
|
يحصل على أحدث حالة لعملية طويلة الأمد. |