SubscribeOptions interface

Paket:

@azure/event-hubs

Alternativ för att konfigurera subscribe metoden på EventHubConsumerClient. Till exempel { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Egenskaper

maxBatchSize	Antalet händelser som ska begäras per batch
maxWaitTimeInSeconds	Den maximala väntetiden för att bygga upp det begärda antalet meddelanden innan data skickas till användarkoden för bearbetning. Om det inte anges är standardvärdet 60 sekunder.
ownerLevel	Den ägarnivå som ska användas när den här prenumerationen prenumererar på partitioner.
prefetchCount	Antalet händelser som begärdes ivrigt och köades utan hänsyn till om en läsning begärdes.
skipParsingBodyAsJson	Alternativ för att inaktivera klienten från att köra JSON.parse() i meddelandetexten när meddelandet tas emot. Inte tillämpligt om meddelandet har skickats med värdet eller sekvensen av TYPEN AMQP-brödtext. Använd det här alternativet om du föredrar att arbeta direkt med byte som finns i meddelandetexten än om klienten försöker parsa dem.
startPosition	Händelsepositionen i en partition för att börja ta emot händelser från om ingen kontrollpunkt hittas. Skicka en karta över partitions-ID till position om du vill använda olika startposition för varje partition.
tracingOptions	Alternativ för att konfigurera spårning.
trackLastEnqueuedEventProperties	Anger om konsumenten ska begära information om den senaste köade händelsen på den associerade partitionen eller inte och spåra informationen när händelser tas emot. När information om partitionens senaste köade händelse spåras kommer varje händelse som tas emot från Event Hubs-tjänsten att innehålla metadata om partitionen som den annars inte skulle ha. Detta resulterar i en liten mängd ytterligare förbrukning av nätverksbandbredd som i allmänhet är en gynnsam kompromiss när den övervägs mot att regelbundet göra begäranden om partitionsegenskaper med hjälp av Event Hub-klienten.

Egenskapsinformation

maxBatchSize

Antalet händelser som ska begäras per batch

maxBatchSize?: number

Egenskapsvärde

number

maxWaitTimeInSeconds

Den maximala väntetiden för att bygga upp det begärda antalet meddelanden innan data skickas till användarkoden för bearbetning. Om det inte anges är standardvärdet 60 sekunder.

maxWaitTimeInSeconds?: number

Egenskapsvärde

number

ownerLevel

Den ägarnivå som ska användas när den här prenumerationen prenumererar på partitioner.

ownerLevel?: number

Egenskapsvärde

number

prefetchCount

Antalet händelser som begärdes ivrigt och köades utan hänsyn till om en läsning begärdes.

prefetchCount?: number

Egenskapsvärde

number

skipParsingBodyAsJson

Alternativ för att inaktivera klienten från att köra JSON.parse() i meddelandetexten när meddelandet tas emot. Inte tillämpligt om meddelandet har skickats med värdet eller sekvensen av TYPEN AMQP-brödtext. Använd det här alternativet om du föredrar att arbeta direkt med byte som finns i meddelandetexten än om klienten försöker parsa dem.

skipParsingBodyAsJson?: boolean

Egenskapsvärde

boolean

startPosition

Händelsepositionen i en partition för att börja ta emot händelser från om ingen kontrollpunkt hittas. Skicka en karta över partitions-ID till position om du vill använda olika startposition för varje partition.

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

Egenskapsvärde

EventPosition | {[partitionId: string]: EventPosition}

tracingOptions

Alternativ för att konfigurera spårning.

tracingOptions?: OperationTracingOptions

Egenskapsvärde

OperationTracingOptions

trackLastEnqueuedEventProperties

Anger om konsumenten ska begära information om den senaste köade händelsen på den associerade partitionen eller inte och spåra informationen när händelser tas emot.

När information om partitionens senaste köade händelse spåras kommer varje händelse som tas emot från Event Hubs-tjänsten att innehålla metadata om partitionen som den annars inte skulle ha. Detta resulterar i en liten mängd ytterligare förbrukning av nätverksbandbredd som i allmänhet är en gynnsam kompromiss när den övervägs mot att regelbundet göra begäranden om partitionsegenskaper med hjälp av Event Hub-klienten.

trackLastEnqueuedEventProperties?: boolean

Egenskapsvärde

boolean