SubscribeOptions interface
Alternativ för att konfigurera metoden subscribe på EventHubConsumerClient.
Till exempel { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }
Egenskaper
| max |
Antalet händelser som ska begäras per batch |
| max |
Den maximala väntetiden för att skapa det begärda antalet meddelanden innan data skickas till användarkoden för bearbetning. Om det inte anges är standardvärdet 60 sekunder. |
| owner |
Ägarnivån som ska användas när den här prenumerationen prenumererar på partitioner. |
| prefetch |
Antalet händelser som begärdes ivrigt och köade utan hänsyn till om en läsning begärdes. |
| skip |
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 skickades med AMQP-brödtexttypens värde eller sekvens. Använd det här alternativet när du föredrar att arbeta direkt med byteen som finns i meddelandetexten än om klienten försöker parsa det. |
| start |
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. |
| tracing |
Alternativ för att konfigurera spårning. |
| track |
Anger om konsumenten ska begära information om den senaste begärda händelsen på den associerade partitionen och spåra informationen när händelser tas emot. När information om partitionens senaste händelse spåras kommer varje händelse som tas emot från Event Hubs-tjänsten att innehålla metadata om partitionen som annars inte skulle göra det. Detta resulterar i en liten mängd ytterligare förbrukning av nätverksbandbredd som i allmänhet är en god kompromiss när det ö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 skapa 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
Ägarnivån 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öade 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 skickades med AMQP-brödtexttypens värde eller sekvens. Använd det här alternativet när du föredrar att arbeta direkt med byteen som finns i meddelandetexten än om klienten försöker parsa det.
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
trackLastEnqueuedEventProperties
Anger om konsumenten ska begära information om den senaste begärda händelsen på den associerade partitionen och spåra informationen när händelser tas emot.
När information om partitionens senaste händelse spåras kommer varje händelse som tas emot från Event Hubs-tjänsten att innehålla metadata om partitionen som annars inte skulle göra det. Detta resulterar i en liten mängd ytterligare förbrukning av nätverksbandbredd som i allmänhet är en god kompromiss när det övervägs mot att regelbundet göra begäranden om partitionsegenskaper med hjälp av Event Hub-klienten.
trackLastEnqueuedEventProperties?: boolean
Egenskapsvärde
boolean