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/{uniqueId}.
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

 تحصل على أحدث حالة لعملية طويلة الأمد.