EventPosition interface

الحزمة:

@azure/event-hubs

يمثل موضع حدث في قسم Event Hub، يستخدم عادة عند استدعاء subscribe() الأسلوب على EventHubConsumerClient لتحديد الموضع في القسم لبدء تلقي الأحداث منه.

للحصول على EventPosition يمثل بداية الدفق أو نهايته، استخدم الثوابت earliestEventPosition وعلى latestEventPosition التوالي.

الخصائص

enqueuedOn	الوقت المحدد في UTC للحدث المحدد بواسطة هذا الموضع. عند توفيرها كرقم، تكون هذه القيمة هي عدد المللي ثانية منذ فترة Unix. من المتوقع أن يكون غير محدد إذا تم إنشاء الموضع للتو من رقم تسلسل أو إزاحة.
isInclusive	يشير إلى ما إذا كانت الإزاحة المحددة شاملة للحدث الذي يحدده. هذه المعلومات هي relevent فقط إذا تم تحديد موضع الحدث بواسطة رقم إزاحة أو تسلسل. القيمة الافتراضية: false.
offset	إزاحة الحدث المحدد بواسطة هذا الموضع. من المتوقع أن يكون غير محدد إذا تم إنشاء الموضع للتو من رقم تسلسل أو وقت مدرج في قائمة الانتظار. الإزاحة هي الموضع النسبي لحدث في سياق القسم. يجب ألا تعتبر الإزاحة قيمة ثابتة. قد تشير نفس الإزاحة إلى حدث مختلف حيث تصل الأحداث إلى الحد العمري للاحتفاظ بها ولم تعد مرئية داخل القسم.
sequenceNumber	رقم تسلسل الحدث الذي تم تحديده بواسطة هذا الموضع. من المتوقع أن يكون غير محدد إذا تم إنشاء الموضع للتو من إزاحة أو وقت مدرج في قائمة الانتظار.

تفاصيل الخاصية

enqueuedOn

الوقت المحدد في UTC للحدث المحدد بواسطة هذا الموضع. عند توفيرها كرقم، تكون هذه القيمة هي عدد المللي ثانية منذ فترة Unix. من المتوقع أن يكون غير محدد إذا تم إنشاء الموضع للتو من رقم تسلسل أو إزاحة.

enqueuedOn?: number | Date

قيمة الخاصية

number | Date

isInclusive

يشير إلى ما إذا كانت الإزاحة المحددة شاملة للحدث الذي يحدده. هذه المعلومات هي relevent فقط إذا تم تحديد موضع الحدث بواسطة رقم إزاحة أو تسلسل. القيمة الافتراضية: false.

isInclusive?: boolean

قيمة الخاصية

boolean

offset

إزاحة الحدث المحدد بواسطة هذا الموضع. من المتوقع أن يكون غير محدد إذا تم إنشاء الموضع للتو من رقم تسلسل أو وقت مدرج في قائمة الانتظار.

الإزاحة هي الموضع النسبي لحدث في سياق القسم. يجب ألا تعتبر الإزاحة قيمة ثابتة. قد تشير نفس الإزاحة إلى حدث مختلف حيث تصل الأحداث إلى الحد العمري للاحتفاظ بها ولم تعد مرئية داخل القسم.

offset?: number | "@latest"

قيمة الخاصية

number | "@latest"

sequenceNumber

رقم تسلسل الحدث الذي تم تحديده بواسطة هذا الموضع. من المتوقع أن يكون غير محدد إذا تم إنشاء الموضع للتو من إزاحة أو وقت مدرج في قائمة الانتظار.

sequenceNumber?: number

قيمة الخاصية

number