SubscribeOptions interface
Možnosti konfigurace metody v subscribe
EventHubConsumerClient
.
Například { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }
.
Vlastnosti
max |
Počet událostí, které se mají vyžádat na dávku |
max |
Maximální doba čekání na sestavení počtu požadovaných 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. |
owner |
Úroveň vlastníka, která se použije jako toto předplatné, se přihlásí k odběru oddílů. |
prefetch |
Počet událostí vyžádaných nedočkavě a zařazených do fronty bez ohledu na to, zda bylo požadováno čtení. |
skip |
Možnost zakázat klientovi spouštění JSON.parse() v textu zprávy při příjmu zprávy. Nelze použít, pokud byla zpráva odeslána s hodnotou nebo posloupností typu textu AMQP. Tuto možnost použijte, pokud chcete pracovat přímo s bajty, které jsou v textu zprávy, než aby se je klient pokusil analyzovat. |
start |
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 mapování ID oddílu do umístění. |
tracing |
Možnosti konfigurace trasování |
track |
Určuje, jestli by měl příjemce požadovat informace o poslední události ve frontě 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í do fronty oddílu, každá událost přijatá ze služby Event Hubs bude obsahovat metadata o oddílu, která by jinak nebyla. Výsledkem je malá dodatečná spotřeba šířky pásma sítě, která je obecně příznivý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čtu požadovaných 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 použije jako toto předplatné, se přihlásí k odběru oddílů.
ownerLevel?: number
Hodnota vlastnosti
number
prefetchCount
Počet událostí vyžádaných nedočkavě a zařazených do fronty bez ohledu na to, zda bylo požadováno čtení.
prefetchCount?: number
Hodnota vlastnosti
number
skipParsingBodyAsJson
Možnost zakázat klientovi spouštění JSON.parse() v textu zprávy při příjmu zprávy. Nelze použít, pokud byla zpráva odeslána s hodnotou nebo posloupností typu textu AMQP. Tuto možnost použijte, pokud chcete pracovat přímo s bajty, které jsou v textu zprávy, než aby se je klient pokusil analyzovat.
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 mapování ID oddílu do umístění.
startPosition?: EventPosition | {[partitionId: string]: EventPosition}
Hodnota vlastnosti
EventPosition | {[partitionId: string]: EventPosition}
tracingOptions
Možnosti konfigurace trasování
tracingOptions?: OperationTracingOptions
Hodnota vlastnosti
trackLastEnqueuedEventProperties
Určuje, jestli by měl příjemce požadovat informace o poslední události ve frontě 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í do fronty oddílu, každá událost přijatá ze služby Event Hubs bude obsahovat metadata o oddílu, která by jinak nebyla. Výsledkem je malá dodatečná spotřeba šířky pásma sítě, která je obecně příznivý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