CheckpointStore interface

الحزمة:

@azure/event-hubs

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

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

يمكن العثور على عمليات CheckpointStore تنفيذ على npm عن طريق البحث عن الحزم ذات البادئة @azure/eventhub-checkpointstore-.

الأساليب

claimOwnership(PartitionOwnership[], OperationOptions)	يتم استدعاؤه للمطالبة بملكية قائمة الأقسام. سيؤدي ذلك إلى إرجاع قائمة الأقسام التي كانت مملوكة بنجاح.
listCheckpoints(string, string, string, OperationOptions)	يسرد جميع نقاط التحقق في مخزن بيانات لمساحة اسم معينة، eventhub ومجموعة مستهلكين.
listOwnership(string, string, string, OperationOptions)	تم استدعاؤه للحصول على قائمة بجميع ملكية القسم الموجودة من مخزن البيانات الأساسي. يمكن أن ترجع نتائج فارغة إذا لم تكن هناك معلومات ملكية موجودة.
updateCheckpoint(Checkpoint, OperationOptions)	التحديثات نقطة التحقق في مخزن البيانات لقسم.

تفاصيل الأسلوب

claimOwnership(PartitionOwnership[], OperationOptions)

يتم استدعاؤه للمطالبة بملكية قائمة الأقسام. سيؤدي ذلك إلى إرجاع قائمة الأقسام التي كانت مملوكة بنجاح.

function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>

المعلمات

partitionOwnership

PartitionOwnership[]

قائمة ملكية القسم التي يدعي هذا المثيل امتلاكها.

options

OperationOptions

مجموعة من الخيارات التي يمكن تحديدها للتأثير على سلوك هذا الأسلوب.

• abortSignal: إشارة تستخدم لطلب إلغاء العملية.
• tracingOptions: خيارات لتكوين التتبع.

المرتجعات

Promise<PartitionOwnership[]>

قائمة بالأقسام التي طالب بها هذا المثيل بنجاح.

listCheckpoints(string, string, string, OperationOptions)

يسرد جميع نقاط التحقق في مخزن بيانات لمساحة اسم معينة، eventhub ومجموعة مستهلكين.

function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>

المعلمات

fullyQualifiedNamespace

string

مساحة اسم مراكز الأحداث المؤهلة بالكامل. من المحتمل أن يكون هذا مشابها ل .servicebus.windows.net.

eventHubName

string

اسم مركز الحدث.

consumerGroup

string

اسم مجموعة المستهلكين.

options

OperationOptions

مجموعة من الخيارات التي يمكن تحديدها للتأثير على سلوك هذا الأسلوب.

• abortSignal: إشارة تستخدم لطلب إلغاء العملية.
• tracingOptions: خيارات لتكوين التتبع.

المرتجعات

Promise<Checkpoint[]>

قائمة بنقاط التحقق لمساحة اسم معينة، و eventhub، ومجموعة مستهلكين.

listOwnership(string, string, string, OperationOptions)

تم استدعاؤه للحصول على قائمة بجميع ملكية القسم الموجودة من مخزن البيانات الأساسي. يمكن أن ترجع نتائج فارغة إذا لم تكن هناك معلومات ملكية موجودة.

function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>

المعلمات

fullyQualifiedNamespace

string

مساحة اسم مراكز الأحداث المؤهلة بالكامل. من المحتمل أن يكون هذا مشابها ل .servicebus.windows.net.

eventHubName

string

اسم مركز الحدث.

consumerGroup

string

اسم مجموعة المستهلكين.

options

OperationOptions

مجموعة من الخيارات التي يمكن تحديدها للتأثير على سلوك هذا الأسلوب.

• abortSignal: إشارة تستخدم لطلب إلغاء العملية.
• tracingOptions: خيارات لتكوين التتبع.

المرتجعات

Promise<PartitionOwnership[]>

قائمة بتفاصيل ملكية القسم لجميع الأقسام التي لديها/لديها مالك.

updateCheckpoint(Checkpoint, OperationOptions)

التحديثات نقطة التحقق في مخزن البيانات لقسم.

function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>

المعلمات

checkpoint

Checkpoint

نقطة التفتيش.

options

OperationOptions

مجموعة من الخيارات التي يمكن تحديدها للتأثير على سلوك هذا الأسلوب.

• abortSignal: إشارة تستخدم لطلب إلغاء العملية.
• tracingOptions: خيارات لتكوين التتبع.

المرتجعات

Promise<void>