BeginBuildDocumentModelOptions interface
خيارات لعملية بناء النموذج.
- Extends
الخصائص الموروثة
abort |
الإشارة التي يمكن استخدامها لإجهاض الطلبات. |
description | وصف نصي للنموذج (يمكن أن يكون أي نص). |
on |
معالج تقدم أولي اختياري سيتم استدعاؤه عند تحديث حالة الاستقصاء. سيتم استدعاء هذا المعالج مرة واحدة مباشرة بعد تهيئة حالة الاستقصاء. |
on |
دالة سيتم استدعاؤها في كل مرة يتم فيها تلقي استجابة من الخادم أثناء تنفيذ العملية المطلوبة. قد يتم استدعاؤه عدة مرات. |
request |
الخيارات المستخدمة عند إنشاء طلبات HTTP وإرسالها لهذه العملية. |
resume |
حالة الاستقصاء المتسلسل. إذا تم توفيرها، فسيتم استئناف عملية التحقق من الحالة المحددة بدلا من البدء كما لو كانت عملية جديدة. |
serializer |
خيارات لتجاوز سلوك التسلسل/إلغاء التسلسل. |
tags | أزواج قيم المفاتيح الإضافية المحددة من قبل المستخدم لإقرانها بالنموذج كبيانات تعريف ثابتة. |
tracing |
الخيارات المستخدمة عند تمكين التتبع. |
update |
مقدار الوقت للانتظار (بالمللي ثانية) بين الطلبات اللاحقة المتعلقة بنفس العملية. |
تفاصيل الخاصية الموروثة
abortSignal
الإشارة التي يمكن استخدامها لإجهاض الطلبات.
abortSignal?: AbortSignalLike
قيمة الخاصية
description
وصف نصي للنموذج (يمكن أن يكون أي نص).
description?: string
قيمة الخاصية
string
onProgress
معالج تقدم أولي اختياري سيتم استدعاؤه عند تحديث حالة الاستقصاء. سيتم استدعاء هذا المعالج مرة واحدة مباشرة بعد تهيئة حالة الاستقصاء.
onProgress?: (state: DocumentModelOperationState) => void
قيمة الخاصية
(state: DocumentModelOperationState) => void
onResponse
دالة سيتم استدعاؤها في كل مرة يتم فيها تلقي استجابة من الخادم أثناء تنفيذ العملية المطلوبة. قد يتم استدعاؤه عدة مرات.
onResponse?: RawResponseCallback
قيمة الخاصية
requestOptions
الخيارات المستخدمة عند إنشاء طلبات HTTP وإرسالها لهذه العملية.
requestOptions?: OperationRequestOptions
قيمة الخاصية
resumeFrom
حالة الاستقصاء المتسلسل. إذا تم توفيرها، فسيتم استئناف عملية التحقق من الحالة المحددة بدلا من البدء كما لو كانت عملية جديدة.
resumeFrom?: string
قيمة الخاصية
string
serializerOptions
خيارات لتجاوز سلوك التسلسل/إلغاء التسلسل.
serializerOptions?: SerializerOptions
قيمة الخاصية
tags
أزواج قيم المفاتيح الإضافية المحددة من قبل المستخدم لإقرانها بالنموذج كبيانات تعريف ثابتة.
tags?: Record<string, string>
قيمة الخاصية
Record<string, string>
موروث منCreateDocumentModelOptions.tags
tracingOptions
الخيارات المستخدمة عند تمكين التتبع.
tracingOptions?: OperationTracingOptions
قيمة الخاصية
updateIntervalInMs
مقدار الوقت للانتظار (بالمللي ثانية) بين الطلبات اللاحقة المتعلقة بنفس العملية.
updateIntervalInMs?: number
قيمة الخاصية
number