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