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