REST Resource: operations

{
  "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.
}

string

الاسم المخصص للخادم، والذي يكون فريدًا فقط داخل نفس الخدمة التي تقوم بإرجاعه في الأصل. إذا كنت تستخدم تعيين HTTP الافتراضي، فيجب أن يكون name اسم مورد ينتهي بـ operations/{unique_id} .

object

بيانات التعريف الخاصة بالخدمة المرتبطة بالعملية. ويحتوي عادةً على معلومات التقدم وبيانات التعريف الشائعة مثل وقت الإنشاء. قد لا توفر بعض الخدمات مثل هذه البيانات التعريفية. يجب أن تقوم أي طريقة تقوم بإرجاع عملية طويلة الأمد بتوثيق نوع بيانات التعريف، إن وجدت.

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

boolean

إذا كانت القيمة false ، فهذا يعني أن العملية لا تزال جارية. إذا كان true ، فقد اكتملت العملية، وسيتوفر error أو response .

object ( Status )

نتيجة الخطأ للعملية في حالة الفشل أو الإلغاء.

object

الاستجابة الطبيعية للعملية في حالة نجاحها. إذا لم تُرجع الطريقة الأصلية أي بيانات عن النجاح، مثل Delete ، فستكون الاستجابة google.protobuf.Empty . إذا كانت الطريقة الأصلية هي Get / Create / Update القياسية، فيجب أن تكون الاستجابة هي المورد. بالنسبة للطرق الأخرى، يجب أن تكون الاستجابة من النوع XxxResponse ، حيث Xxx هو اسم الطريقة الأصلية. على سبيل المثال، إذا كان اسم الطريقة الأصلية هو TakeSnapshot() ، فإن نوع الاستجابة المستنتج هو TakeSnapshotResponse .

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

{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}

integer

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

string

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

object

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

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