REST Resource: projects.operations

المورد: العملية

يمثّل هذا المورد عملية طويلة الأمد ناتجة عن طلب بيانات من واجهة برمجة تطبيقات على الشبكة.

تمثيل JSON
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field result can be only one of the following: "error": { object (Status) }, "response": { "@type": string, field1: ..., ... } // End of list of possible types for union field result. }

الحقول
name	string الاسم الذي يحدّده الخادم، وهو اسم فريد فقط ضمن الخدمة نفسها التي تعرضه في الأصل. في حال استخدام عملية الربط التلقائية ببروتوكول HTTP، يجب أن يكون name اسم مورد ينتهي بـ operations/{unique_id}.
metadata	object البيانات الوصفية الخاصة بالخدمة والمرتبطة بالعملية ويتضمّن عادةً معلومات عن مستوى التقدّم والبيانات الوصفية الشائعة، مثل وقت الإنشاء. قد لا توفّر بعض الخدمات هذه البيانات الوصفية. يجب توثيق نوع البيانات الوصفية لأي طريقة تعرض عملية طويلة الأمد، إذا كان ذلك منطبقًا. كائن يحتوي على حقول من أي نوع. يحتوي حقل إضافي "@type" على معرّف موارد منتظم (URI) يحدّد النوع. مثال: { "id": 1234, "@type": "types.example.com/standard/id" }
done	boolean إذا كانت القيمة false، يعني ذلك أنّ العملية لا تزال قيد التقدّم. إذا كانت القيمة true، تكون العملية قد اكتملت، ويتوفّر إما error أو response.
حقل الدمج result نتيجة العملية، والتي يمكن أن تكون error أو response صالحًا. إذا كان done == false، لم يتم ضبط error ولا response. إذا كان done == true، يمكن ضبط أحد الحقلين error أو response فقط. قد لا تقدّم بعض الخدمات النتيجة. يمكن أن تكون result إحدى القيم التالية فقط:
error	object (Status) نتيجة الخطأ في العملية في حال حدوث خطأ أو إلغاء
response	object الاستجابة العادية والناجحة للعملية إذا لم تعرض الطريقة الأصلية أي بيانات عند النجاح، مثل Delete، تكون الاستجابة google.protobuf.Empty. إذا كانت الطريقة الأصلية هي Get/Create/Update العادية، يجب أن يكون الرد هو المورد. بالنسبة إلى الطرق الأخرى، يجب أن يتضمّن الرد النوع XxxResponse، حيث يمثّل Xxx اسم الطريقة الأصلية. على سبيل المثال، إذا كان اسم الطريقة الأصلية هو TakeSnapshot()، سيكون نوع الرد المستنتج هو TakeSnapshotResponse. كائن يحتوي على حقول من أي نوع. يحتوي حقل إضافي "@type" على معرّف موارد منتظم (URI) يحدّد النوع. مثال: { "id": 1234, "@type": "types.example.com/standard/id" }

الطُرق
cancel	تبدأ هذه الطريقة عملية إلغاء غير متزامنة لعملية تستغرق وقتًا طويلاً.
delete	تحذف هذه الطريقة عملية تستغرق وقتًا طويلاً.
get	تعرض هذه الطريقة أحدث حالة لعملية تستغرق وقتًا طويلاً.
list	تعرض هذه الطريقة العمليات التي تتطابق مع الفلتر المحدّد في الطلب.
wait	تنتظر هذه الطريقة إلى أن تنتهي العملية المحدّدة الطويلة الأمد أو تصل إلى مهلة محدّدة على الأكثر، ثم تعرض أحدث حالة.