EventDataBatch interface

Paket:

@azure/event-hubs

Antarmuka yang mewakili batch peristiwa yang dapat digunakan untuk mengirim peristiwa ke Event Hub.

Untuk membuat batch, gunakan metode createBatch() pada EventHubProducerClient. Untuk mengirim batch, gunakan metode sendBatch() pada klien yang sama. Untuk mengisi batch, gunakan metode tryAdd() pada batch itu sendiri.

Properti

count	Jumlah peristiwa yang ditambahkan ke batch.
maxSizeInBytes	Ukuran maksimum batch, dalam byte. Fungsi tryAdd pada batch akan mengembalikan false jika peristiwa yang ditambahkan menyebabkan ukuran batch melebihi batas ini. Gunakan metode createBatch() pada EventHubProducerClient untuk mengatur maxSizeInBytes.
sizeInBytes	Ukuran batch dalam byte setelah peristiwa yang ditambahkan ke dalamnya telah dikodekan ke dalam satu pesan AMQP.

Metode

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Menambahkan peristiwa ke batch jika diizinkan oleh batas ukuran batch. NOTE: Selalu ingat untuk memeriksa nilai pengembalian metode ini, sebelum memanggilnya lagi untuk peristiwa berikutnya.

Detail Properti

count

Jumlah peristiwa yang ditambahkan ke batch.

count: number

Nilai Properti

number

maxSizeInBytes

Ukuran maksimum batch, dalam byte. Fungsi tryAdd pada batch akan mengembalikan false jika peristiwa yang ditambahkan menyebabkan ukuran batch melebihi batas ini. Gunakan metode createBatch() pada EventHubProducerClient untuk mengatur maxSizeInBytes.

maxSizeInBytes: number

Nilai Properti

number

sizeInBytes

Ukuran batch dalam byte setelah peristiwa yang ditambahkan ke dalamnya telah dikodekan ke dalam satu pesan AMQP.

sizeInBytes: number

Nilai Properti

number

Detail Metode

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Menambahkan peristiwa ke batch jika diizinkan oleh batas ukuran batch. NOTE: Selalu ingat untuk memeriksa nilai pengembalian metode ini, sebelum memanggilnya lagi untuk peristiwa berikutnya.

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

Parameter

eventData

EventData | AmqpAnnotatedMessage

Objek data peristiwa individual atau AmqpAnnotatedMessage.

options

TryAddOptions

Mengembalikan

boolean

Nilai boolean yang menunjukkan apakah data peristiwa telah ditambahkan ke batch atau tidak.