SubscribeOptions interface

Paket:

@azure/event-hubs

Opsi untuk mengonfigurasi metode subscribe pada EventHubConsumerClient. Misalnya, { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Properti

maxBatchSize	Jumlah peristiwa yang diminta per batch
maxWaitTimeInSeconds	Jumlah waktu maksimum untuk menunggu untuk membangun jumlah pesan yang diminta sebelum meneruskan data ke kode pengguna untuk diproses. Jika tidak disediakan, defaultnya adalah 60 detik.
ownerLevel	Tingkat pemilik untuk digunakan karena langganan ini berlangganan partisi.
prefetchCount	Jumlah peristiwa yang diminta dengan bersemangat dan diantrekan tanpa memperhatikan apakah bacaan diminta.
skipParsingBodyAsJson	Opsi untuk menonaktifkan klien agar tidak menjalankan JSON.parse() pada isi pesan saat menerima pesan. Tidak berlaku jika pesan dikirim dengan nilai atau urutan tipe isi AMQP. Gunakan opsi ini ketika Anda lebih suka bekerja langsung dengan byte yang ada di isi pesan daripada meminta klien mengurainya.
startPosition	Posisi peristiwa dalam partisi untuk mulai menerima peristiwa dari jika tidak ada titik pemeriksaan yang ditemukan. Teruskan peta id partisi ke posisi jika Anda ingin menggunakan posisi awal yang berbeda untuk setiap partisi.
tracingOptions	Opsi untuk mengonfigurasi pelacakan.
trackLastEnqueuedEventProperties	Menunjukkan apakah konsumen harus meminta informasi tentang peristiwa antrean terakhir pada partisi terkait atau tidak, dan melacak informasi tersebut saat peristiwa diterima. Ketika informasi tentang peristiwa antrean terakhir partisi sedang dilacak, setiap peristiwa yang diterima dari layanan Azure Event Hubs akan membawa metadata tentang partisi yang tidak akan dilacak. Ini menghasilkan sejumlah kecil konsumsi bandwidth jaringan tambahan yang umumnya merupakan trade-off yang menguntungkan ketika dipertimbangkan untuk membuat permintaan secara berkala untuk properti partisi menggunakan klien Event Hub.

Detail Properti

maxBatchSize

Jumlah peristiwa yang diminta per batch

maxBatchSize?: number

Nilai Properti

number

maxWaitTimeInSeconds

Jumlah waktu maksimum untuk menunggu untuk membangun jumlah pesan yang diminta sebelum meneruskan data ke kode pengguna untuk diproses. Jika tidak disediakan, defaultnya adalah 60 detik.

maxWaitTimeInSeconds?: number

Nilai Properti

number

ownerLevel

Tingkat pemilik untuk digunakan karena langganan ini berlangganan partisi.

ownerLevel?: number

Nilai Properti

number

prefetchCount

Jumlah peristiwa yang diminta dengan bersemangat dan diantrekan tanpa memperhatikan apakah bacaan diminta.

prefetchCount?: number

Nilai Properti

number

skipParsingBodyAsJson

Opsi untuk menonaktifkan klien agar tidak menjalankan JSON.parse() pada isi pesan saat menerima pesan. Tidak berlaku jika pesan dikirim dengan nilai atau urutan tipe isi AMQP. Gunakan opsi ini ketika Anda lebih suka bekerja langsung dengan byte yang ada di isi pesan daripada meminta klien mengurainya.

skipParsingBodyAsJson?: boolean

Nilai Properti

boolean

startPosition

Posisi peristiwa dalam partisi untuk mulai menerima peristiwa dari jika tidak ada titik pemeriksaan yang ditemukan. Teruskan peta id partisi ke posisi jika Anda ingin menggunakan posisi awal yang berbeda untuk setiap partisi.

startPosition?: EventPosition | {[partitionId: string]: EventPosition}

Nilai Properti

EventPosition | {[partitionId: string]: EventPosition}

tracingOptions

Opsi untuk mengonfigurasi pelacakan.

tracingOptions?: OperationTracingOptions

Nilai Properti

OperationTracingOptions

trackLastEnqueuedEventProperties

Menunjukkan apakah konsumen harus meminta informasi tentang peristiwa antrean terakhir pada partisi terkait atau tidak, dan melacak informasi tersebut saat peristiwa diterima.

Ketika informasi tentang peristiwa antrean terakhir partisi sedang dilacak, setiap peristiwa yang diterima dari layanan Azure Event Hubs akan membawa metadata tentang partisi yang tidak akan dilacak. Ini menghasilkan sejumlah kecil konsumsi bandwidth jaringan tambahan yang umumnya merupakan trade-off yang menguntungkan ketika dipertimbangkan untuk membuat permintaan secara berkala untuk properti partisi menggunakan klien Event Hub.

trackLastEnqueuedEventProperties?: boolean

Nilai Properti

boolean