SubscribeOptions interface

Balíček:

@azure/event-hubs

Možnosti konfigurace metody subscribe na EventHubConsumerClient. Například { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Vlastnosti

maxBatchSize	Počet událostí, které se mají vyžádat na dávku
maxWaitTimeInSeconds	Maximální doba čekání na sestavení požadovaného počtu zpráv před předáním dat uživatelskému kódu ke zpracování. Pokud není zadaný, výchozí hodnota je 60 sekund.
ownerLevel	Úroveň vlastníka, která se má použít jako toto předplatné, se přihlásí k odběru oddílů.
prefetchCount	Počet událostí požadovaných dychtivě a zařazených do fronty bez ohledu na to, jestli bylo požadováno čtení.
skipParsingBodyAsJson	Možnost zakázat spuštění klienta JSON.parse() v textu zprávy při přijetí zprávy. Nelze použít, pokud byla zpráva odeslána s hodnotou nebo sekvencí typu textu AMQP. Tuto možnost použijte, pokud chcete pracovat přímo s bajty, které jsou přítomné v textu zprávy, než aby se klient pokusil parsovat.
startPosition	Pozice události v oddílu, ze které se mají začít přijímat události, pokud se nenajde žádný kontrolní bod. Pokud chcete pro každý oddíl použít jinou počáteční pozici, předejte mapu ID oddílu.
tracingOptions	Možnosti konfigurace trasování
trackLastEnqueuedEventProperties	Určuje, zda má příjemce požadovat informace o poslední události zařazení do fronty v přidruženém oddílu a sledovat tyto informace při přijetí událostí. Když se sledují informace o poslední události zařazení oddílu do fronty, každá událost přijatá ze služby Event Hubs bude obsahovat metadata o oddílu, který by jinak ne. Výsledkem je malé množství dodatečné spotřeby šířky pásma sítě, která je obecně uspokojivým kompromisem, když se uvažuje o pravidelném provádění požadavků na vlastnosti oddílu pomocí klienta centra událostí.

Podrobnosti vlastnosti

maxBatchSize

Počet událostí, které se mají vyžádat na dávku

maxBatchSize?: number

Hodnota vlastnosti

number

maxWaitTimeInSeconds

Maximální doba čekání na sestavení požadovaného počtu zpráv před předáním dat uživatelskému kódu ke zpracování. Pokud není zadaný, výchozí hodnota je 60 sekund.

maxWaitTimeInSeconds?: number

Hodnota vlastnosti

number

ownerLevel

Úroveň vlastníka, která se má použít jako toto předplatné, se přihlásí k odběru oddílů.

ownerLevel?: number

Hodnota vlastnosti

number

prefetchCount

Počet událostí požadovaných dychtivě a zařazených do fronty bez ohledu na to, jestli bylo požadováno čtení.

prefetchCount?: number

Hodnota vlastnosti

number

skipParsingBodyAsJson

Možnost zakázat spuštění klienta JSON.parse() v textu zprávy při přijetí zprávy. Nelze použít, pokud byla zpráva odeslána s hodnotou nebo sekvencí typu textu AMQP. Tuto možnost použijte, pokud chcete pracovat přímo s bajty, které jsou přítomné v textu zprávy, než aby se klient pokusil parsovat.

skipParsingBodyAsJson?: boolean

Hodnota vlastnosti

boolean

startPosition

Pozice události v oddílu, ze které se mají začít přijímat události, pokud se nenajde žádný kontrolní bod. Pokud chcete pro každý oddíl použít jinou počáteční pozici, předejte mapu ID oddílu.

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

Hodnota vlastnosti

EventPosition | {[partitionId: string]: EventPosition}

tracingOptions

Možnosti konfigurace trasování

tracingOptions?: OperationTracingOptions

Hodnota vlastnosti

OperationTracingOptions

trackLastEnqueuedEventProperties

Určuje, zda má příjemce požadovat informace o poslední události zařazení do fronty v přidruženém oddílu a sledovat tyto informace při přijetí událostí.

Když se sledují informace o poslední události zařazení oddílu do fronty, každá událost přijatá ze služby Event Hubs bude obsahovat metadata o oddílu, který by jinak ne. Výsledkem je malé množství dodatečné spotřeby šířky pásma sítě, která je obecně uspokojivým kompromisem, když se uvažuje o pravidelném provádění požadavků na vlastnosti oddílu pomocí klienta centra událostí.

trackLastEnqueuedEventProperties?: boolean

Hodnota vlastnosti

boolean