REST Resource: 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" }

الحالة

يحدّد النوع Status نموذج خطأ منطقيًا مناسبًا لبيئات البرمجة المختلفة، بما في ذلك واجهات REST وRPC. يتم استخدامها من خلال gRPC. تحتوي كل رسالة Status على ثلاثة أجزاء من البيانات: رمز الخطأ ورسالة الخطأ وتفاصيل الخطأ.

يمكنك الاطّلاع على مزيد من المعلومات حول نموذج الخطأ هذا وكيفية التعامل معه في دليل تصميم واجهة برمجة التطبيقات.

تمثيل JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
الحقول
code

integer

رمز الحالة، ويجب أن تكون قيمة تعدادية من google.rpc.Code.
message

string

رسالة خطأ موجّهة إلى المطوّرين، ويجب أن تكون باللغة الإنجليزية. يجب ترجمة أي رسالة خطأ تظهر للمستخدم وإرسالها في الحقل google.rpc.Status.details، أو ترجمتها من قِبل العميل.
details[]

object

قائمة بالرسائل التي تتضمّن تفاصيل الخطأ هناك مجموعة شائعة من أنواع الرسائل التي يمكن أن تستخدمها واجهات برمجة التطبيقات.

كائن يحتوي على حقول من أي نوع. يحتوي حقل إضافي "@type" على معرّف موارد منتظم (URI) يحدّد النوع. مثال: { "id": 1234, "@type": "types.example.com/standard/id" }

الطُرق

get

 تعرض هذه الطريقة أحدث حالة لعملية تستغرق وقتًا طويلاً.