Package google.longrunning

الفهرس

العمليات

تُدير العمليات الطويلة باستخدام خدمة واجهة برمجة التطبيقات.

إذا كان إكمال إحدى طرق واجهة برمجة التطبيقات يستغرق عادةً وقتًا طويلاً، يمكن تصميمها لعرض Operation على العميل، ويمكن للعميل استخدام هذه الواجهة لتلقّي الاستجابة الحقيقية بشكل غير متزامن من خلال التحقّق من مورد العملية بشكل متكرّر، أو تمرير مورد العملية إلى واجهة برمجة تطبيقات أخرى (مثل Pub/Sub API) لتلقّي الاستجابة. يجب أن تنفّذ أي خدمة واجهة برمجة تطبيقات تعرض عمليات طويلة واجهة Operations لكي يحصل المطوّرون على تجربة عميل متّسقة.

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

(غير متاح حاليًا) يبدأ عملية إلغاء غير متزامنة لعملية طويلة.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform
DeleteOperation

rpc DeleteOperation(DeleteOperationRequest) returns (Empty)

(غير متاح حاليًا) يحذف عملية طويلة.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform
GetOperation

rpc GetOperation(GetOperationRequest) returns (Operation)

تتيح هذه الطريقة الاطّلاع على أحدث حالة لعملية طويلة، ويمكن للعملاء استخدامها للتحقّق من نتيجة العملية على فترات زمنية منتظمة تنصح بها خدمة واجهة برمجة التطبيقات. تتيح هذه الطريقة الاطّلاع على أحدث حالة لعملية طويلة، ويمكن للعملاء استخدامها للتحقّق من نتيجة العملية على فترات زمنية منتظمة تنصح بها خدمة واجهة برمجة التطبيقات.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform
أذونات IAM

يتطلب إذن IAM التالي على المورد name:

  • routeoptimization.operations.get

لمزيد من المعلومات، يُرجى الاطّلاع على مستندات IAM.
ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

(غير متاح حاليًا) يعرض العمليات التي تتطابق مع الفلتر المحدّد في الطلب.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform
WaitOperation

rpc WaitOperation(WaitOperationRequest) returns (Operation)

(غير متاح حاليًا) ينتظر إلى أن تكتمل العملية الطويلة المحدّدة أو تصل إلى حد أقصى لمهلة محدّدة، ويعرض أحدث حالة.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform

CancelOperationRequest

رسالة الطلب الخاصة بـ Operations.CancelOperation

الحقول
name

string

اسم مورد العملية المطلوب إلغاؤها

DeleteOperationRequest

رسالة الطلب الخاصة بـ Operations.DeleteOperation

الحقول
name

string

اسم مورد العملية المطلوب حذفها

GetOperationRequest

رسالة الطلب الخاصة بـ Operations.GetOperation

الحقول
name

string

يمثّل اسم مورد العملية.

ListOperationsRequest

رسالة الطلب الخاصة بـ Operations.ListOperations

الحقول
name

string

اسم المورد الرئيسي للعملية
filter

string

فلتر القائمة العادي
page_size

int32

حجم صفحة القائمة العادي
page_token

string

الرمز المميّز لصفحة القائمة العادي
return_partial_success

bool

عند ضبط هذه القيمة على true، يتم عرض العمليات التي يمكن الوصول إليها بشكل عادي، ويتم عرض العمليات التي لا يمكن الوصول إليها في حقل ListOperationsResponse.unreachable.

لا يمكن أن تكون هذه القيمة true إلا عند القراءة من خلال مجموعات. على سبيل المثال، عند ضبط parent على "projects/example/locations/-".

لا يكون هذا الحقل متاحًا تلقائيًا وسيؤدي إلى ظهور الخطأ UNIMPLEMENTED إذا تم ضبطه ما لم يتم توثيقه بشكل صريح في مستندات الخدمة أو المنتج.

ListOperationsResponse

رسالة الاستجابة الخاصة بـ Operations.ListOperations

الحقول
operations[]

Operation

قائمة بالعمليات التي تتطابق مع الفلتر المحدّد في الطلب
next_page_token

string

الرمز المميّز لصفحة القائمة التالية العادي
unreachable[]

string

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

Operation

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

الحقول
name

string

هو الاسم الذي يُعيّنه الخادم، ويكون فريدًا فقط ضمن الخدمة نفسها التي أرسلت الاسم في الاستجابة. إذا كنت تستخدم أسلوب ربط HTTP التلقائي، يجب أن يكون حقل name اسم مورد ينتهي بالشكل التالي: operations/{unique_id}.
metadata

Any

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

bool

إذا كانت القيمة false، هذا يعني أنّ العملية ما زالت قيد التنفيذ. أما إذا كانت true، فهذا يعني أنّ العملية اكتملت، ويمكن عندها الوصول إلى error أو response.
حقل الاتحاد result يمثّل نتيجة العملية، والتي يمكن أن تكون إما error أو response صالحة. إذا كانت done == false، هذا يعني أنّه لم يتم ضبط أي من error أو response. إذا كانت done == true، هذا يعني أنّه يمكن ضبط إما error أو response فقط. يُرجى العِلم أنّ بعض الخدمات قد لا توفّر النتيجة. لا يمكن أن يكون result إلا أحد الخيارَين التاليَين:
error

Status

يمثّل نتيجة الخطأ للعملية في حال فشلها أو إلغائها.
response

Any

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

WaitOperationRequest

رسالة الطلب الخاصة بـ Operations.WaitOperation

الحقول
name

string

اسم مورد العملية المطلوب الانتظار إلى أن تكتمل
timeout

Duration

الحد الأقصى للمدة التي يجب الانتظار خلالها قبل انتهاء المهلة إذا تم ترك هذا الحقل فارغًا، سيكون الانتظار على الأكثر الوقت المسموح به بموجب بروتوكول HTTP/RPC الأساسي. إذا تم تحديد مهلة سياق RPC أيضًا، سيتم استخدام المهلة الأقصر.