REST Resource: projects.operations

المورد: العملية

يمثّل هذا المورد عملية طويلة ناتجة عن طلب بيانات من واجهة برمجة التطبيقات من الشبكة.

تمثيل JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of mutually exclusive fields.
}
الحقول
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.
تمثّل نتيجة العملية، التي يمكن أن تكون error أو response صالحًا. إذا كانت done == false، لا يتم ضبط error ولا response. إذا كانت done == true، يمكن ضبط error أو response فقط. يُرجى الِعلم أنّ بعض الخدمات قد لا توفّر النتيجة. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
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

 يسرد هذا الإجراء العمليات التي تطابق الفلتر المحدّد في الطلب.

wait

 ينتظر هذا الإجراء إلى أن تكتمل العملية الطويلة المحدّدة أو أن يصل إلى مهلة قصوى محدّدة، ويعرض أحدث حالة.