SubscribeOptions interface

Csomag:

@azure/event-hubs

A metódus konfigurálásának subscribe beállításai a EventHubConsumerClientkövetkezőn: . Például: { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Tulajdonságok

maxBatchSize	Kötegenként lekérendő események száma
maxWaitTimeInSeconds	A kért üzenetek számának összeállítására váró maximális idő, mielőtt az adatokat a felhasználói kódnak továbbadja feldolgozásra. Ha nincs megadva, az alapértelmezés szerint 60 másodperc.
ownerLevel	Az előfizetéshez használt tulajdonosi szint a partíciókra fizet elő.
prefetchCount	A kíváncsian és várólistára helyezett események száma, tekintet nélkül arra, hogy az olvasást kérték-e.
skipParsingBodyAsJson	Lehetőség arra, hogy az ügyfél letiltsa a JSON.parse() futtatását az üzenet törzsében az üzenet fogadásakor. Nem alkalmazható, ha az üzenetet AMQP törzstípus-értékkel vagy sorozattal küldték. Akkor használja ezt a lehetőséget, ha inkább közvetlenül az üzenet törzsében található bájtokkal dolgozik, mint ha az ügyfél megkísérli elemezni.
startPosition	A partíció eseménypozíciója az események fogadásának megkezdéséhez, ha nem található ellenőrzőpont. Adjon át egy partícióazonosító-térképet a pozícióhoz, ha különböző kezdőpozíciót szeretne használni az egyes partíciókhoz.
tracingOptions	A nyomkövetés konfigurálásának lehetőségei.
trackLastEnqueuedEventProperties	Jelzi, hogy a fogyasztónak kell-e adatokat kérnie a társított partíción található utolsó lekérdezett eseményről, és nyomon követheti ezeket az információkat az események fogadása során. A partíció utolsó lekérdezett eseményével kapcsolatos információk nyomon követésekor az Event Hubs szolgáltatástól kapott minden esemény metaadatokat fog hordozni a partícióról, amelyet egyébként nem. Ez kis mennyiségű további hálózati sávszélesség-használatot eredményez, amely általában kedvező kompromisszumot jelent, ha figyelembe vesszük, hogy a partíciótulajdonságokra vonatkozó kéréseket rendszeres időközönként az Event Hub-ügyfél használatával kell elvégezni.

Tulajdonság adatai

maxBatchSize

Kötegenként lekérendő események száma

maxBatchSize?: number

Tulajdonság értéke

number

maxWaitTimeInSeconds

A kért üzenetek számának összeállítására váró maximális idő, mielőtt az adatokat a felhasználói kódnak továbbadja feldolgozásra. Ha nincs megadva, az alapértelmezés szerint 60 másodperc.

maxWaitTimeInSeconds?: number

Tulajdonság értéke

number

ownerLevel

Az előfizetéshez használt tulajdonosi szint a partíciókra fizet elő.

ownerLevel?: number

Tulajdonság értéke

number

prefetchCount

A kíváncsian és várólistára helyezett események száma, tekintet nélkül arra, hogy az olvasást kérték-e.

prefetchCount?: number

Tulajdonság értéke

number

skipParsingBodyAsJson

Lehetőség arra, hogy az ügyfél letiltsa a JSON.parse() futtatását az üzenet törzsében az üzenet fogadásakor. Nem alkalmazható, ha az üzenetet AMQP törzstípus-értékkel vagy sorozattal küldték. Akkor használja ezt a lehetőséget, ha inkább közvetlenül az üzenet törzsében található bájtokkal dolgozik, mint ha az ügyfél megkísérli elemezni.

skipParsingBodyAsJson?: boolean

Tulajdonság értéke

boolean

startPosition

A partíció eseménypozíciója az események fogadásának megkezdéséhez, ha nem található ellenőrzőpont. Adjon át egy partícióazonosító-térképet a pozícióhoz, ha különböző kezdőpozíciót szeretne használni az egyes partíciókhoz.

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

Tulajdonság értéke

EventPosition | {[partitionId: string]: EventPosition}

tracingOptions

A nyomkövetés konfigurálásának lehetőségei.

tracingOptions?: OperationTracingOptions

Tulajdonság értéke

OperationTracingOptions

trackLastEnqueuedEventProperties

Jelzi, hogy a fogyasztónak kell-e adatokat kérnie a társított partíción található utolsó lekérdezett eseményről, és nyomon követheti ezeket az információkat az események fogadása során.

A partíció utolsó lekérdezett eseményével kapcsolatos információk nyomon követésekor az Event Hubs szolgáltatástól kapott minden esemény metaadatokat fog hordozni a partícióról, amelyet egyébként nem. Ez kis mennyiségű további hálózati sávszélesség-használatot eredményez, amely általában kedvező kompromisszumot jelent, ha figyelembe vesszük, hogy a partíciótulajdonságokra vonatkozó kéréseket rendszeres időközönként az Event Hub-ügyfél használatával kell elvégezni.

trackLastEnqueuedEventProperties?: boolean

Tulajdonság értéke

boolean