REST Resource: projects.databases.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

يسرد العمليات التي تتطابق مع الفلتر المحدَّد في الطلب.