EventDataBatch interface

الحزمة:

@azure/event-hubs

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

لإنشاء الدفعة، استخدم الأسلوب على createBatch()EventHubProducerClient. لإرسال الدفعة، استخدم sendBatch() الأسلوب على نفس العميل. لتعبئة الدفعة، استخدم الأسلوب على tryAdd() الدفعة نفسها.

الخصائص

count	عدد الأحداث المضافة إلى الدفعة.
maxSizeInBytes	الحد الأقصى لحجم الدفعة بالبايت. tryAdd سترجع false الدالة على الدفعة إذا تسبب الحدث الذي تتم إضافته في تجاوز حجم الدفعة لهذا الحد. createBatch() استخدم الأسلوب على EventHubProducerClient لتعيين maxSizeInBytes.
sizeInBytes	حجم الدفعة بالبايت بعد أن يتم ترميز الأحداث المضافة إليها في رسالة AMQP واحدة.

الأساليب

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

يضيف حدثا إلى الدفعة إذا كان مسموحا به من قبل حد حجم الدفعة. ملاحظة: تذكر دائما التحقق من القيمة المرجعة لهذا الأسلوب، قبل استدعائه مرة أخرى للحدث التالي.

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

count

عدد الأحداث المضافة إلى الدفعة.

count: number

قيمة الخاصية

number

maxSizeInBytes

الحد الأقصى لحجم الدفعة بالبايت. tryAdd سترجع false الدالة على الدفعة إذا تسبب الحدث الذي تتم إضافته في تجاوز حجم الدفعة لهذا الحد. createBatch() استخدم الأسلوب على EventHubProducerClient لتعيين maxSizeInBytes.

maxSizeInBytes: number

قيمة الخاصية

number

sizeInBytes

حجم الدفعة بالبايت بعد أن يتم ترميز الأحداث المضافة إليها في رسالة AMQP واحدة.

sizeInBytes: number

قيمة الخاصية

number

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

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

يضيف حدثا إلى الدفعة إذا كان مسموحا به من قبل حد حجم الدفعة. ملاحظة: تذكر دائما التحقق من القيمة المرجعة لهذا الأسلوب، قبل استدعائه مرة أخرى للحدث التالي.

function tryAdd(eventData: EventData | AmqpAnnotatedMessage, options?: TryAddOptions): boolean

المعلمات

eventData

EventData | AmqpAnnotatedMessage

كائن بيانات حدث فردي أو AmqpAnnotatedMessage.

options

TryAddOptions

المرتجعات

boolean

قيمة منطقية تشير إلى ما إذا تمت إضافة بيانات الحدث إلى الدفعة أم لا.