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

سيحتوي هذا الحقل على كائن DevicesLongRunningOperationMetadata إذا تم إنشاء العملية بواسطة claimAsync أو unclaimAsync أو updateMetadataAsync.

كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي "@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)

لن يتم دائمًا ضبط هذا الحقل إذا تم إنشاء العملية من قِبل claimAsync أو unclaimAsync أو updateMetadataAsync. وفي هذه الحالة، يتم تعيين معلومات الخطأ لكل جهاز في response.perDeviceStatus.result.status.
response

object

سيحتوي هذا الحقل على كائن DevicesLongRunningOperationResponse إذا تم إنشاء العملية بواسطة claimAsync أو unclaimAsync أو updateMetadataAsync.

كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي "@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

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