SubscribeOptions interface

Pakket:

@azure/event-hubs

Opties voor het configureren van de subscribe methode op de EventHubConsumerClient. Bijvoorbeeld: { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Eigenschappen

maxBatchSize	Het aantal gebeurtenissen dat per batch moet worden aangevraagd
maxWaitTimeInSeconds	De maximale tijd die moet worden gewacht om het aantal aangevraagde berichten op te bouwen voordat de gegevens worden doorgegeven aan gebruikerscode voor verwerking. Als dit niet wordt opgegeven, wordt de standaardwaarde ingesteld op 60 seconden.
ownerLevel	Het eigenaarsniveau dat moet worden gebruikt als dit abonnement zich abonneert op partities.
prefetchCount	Het aantal gebeurtenissen dat gretig is aangevraagd en in de wachtrij is geplaatst, zonder rekening te houden met het feit of een leesbewerking is aangevraagd.
skipParsingBodyAsJson	Optie om de client uit te schakelen voor het uitvoeren van JSON.parse() op de berichttekst bij ontvangst van het bericht. Niet van toepassing als het bericht is verzonden met de waarde of volgorde van het AMQP-hoofdteksttype. Gebruik deze optie als u liever rechtstreeks werkt met de bytes die aanwezig zijn in de berichttekst dan dat de client deze probeert te parseren.
startPosition	De gebeurtenispositie in een partitie om gebeurtenissen van te ontvangen als er geen controlepunt wordt gevonden. Geef een toewijzing van de partitie-id door aan de positie als u een andere beginpositie voor elke partitie wilt gebruiken.
tracingOptions	Opties voor het configureren van tracering.
trackLastEnqueuedEventProperties	Hiermee wordt aangegeven of de consument al dan niet informatie moet aanvragen over de laatste enqueued-gebeurtenis op de bijbehorende partitie en deze informatie moet bijhouden wanneer gebeurtenissen worden ontvangen. Wanneer informatie over de laatste enqueuedgebeurtenis van de partitie wordt bijgehouden, bevat elke gebeurtenis die wordt ontvangen van de Event Hubs-service metagegevens over de partitie die anders niet het geval was. Dit resulteert in een klein extra verbruik van netwerkbandbreedte. Dit is over het algemeen een gunstige afweging wanneer het wordt overwogen om periodiek aanvragen voor partitie-eigenschappen te doen met behulp van de Event Hub-client.

Eigenschapdetails

maxBatchSize

Het aantal gebeurtenissen dat per batch moet worden aangevraagd

maxBatchSize?: number

Waarde van eigenschap

number

maxWaitTimeInSeconds

De maximale tijd die moet worden gewacht om het aantal aangevraagde berichten op te bouwen voordat de gegevens worden doorgegeven aan gebruikerscode voor verwerking. Als dit niet wordt opgegeven, wordt de standaardwaarde ingesteld op 60 seconden.

maxWaitTimeInSeconds?: number

Waarde van eigenschap

number

ownerLevel

Het eigenaarsniveau dat moet worden gebruikt als dit abonnement zich abonneert op partities.

ownerLevel?: number

Waarde van eigenschap

number

prefetchCount

Het aantal gebeurtenissen dat gretig is aangevraagd en in de wachtrij is geplaatst, zonder rekening te houden met het feit of een leesbewerking is aangevraagd.

prefetchCount?: number

Waarde van eigenschap

number

skipParsingBodyAsJson

Optie om de client uit te schakelen voor het uitvoeren van JSON.parse() op de berichttekst bij ontvangst van het bericht. Niet van toepassing als het bericht is verzonden met de waarde of volgorde van het AMQP-hoofdteksttype. Gebruik deze optie als u liever rechtstreeks werkt met de bytes die aanwezig zijn in de berichttekst dan dat de client deze probeert te parseren.

skipParsingBodyAsJson?: boolean

Waarde van eigenschap

boolean

startPosition

De gebeurtenispositie in een partitie om gebeurtenissen van te ontvangen als er geen controlepunt wordt gevonden. Geef een toewijzing van de partitie-id door aan de positie als u een andere beginpositie voor elke partitie wilt gebruiken.

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

Waarde van eigenschap

EventPosition | {[partitionId: string]: EventPosition}

tracingOptions

Opties voor het configureren van tracering.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

trackLastEnqueuedEventProperties

Hiermee wordt aangegeven of de consument al dan niet informatie moet aanvragen over de laatste enqueued-gebeurtenis op de bijbehorende partitie en deze informatie moet bijhouden wanneer gebeurtenissen worden ontvangen.

Wanneer informatie over de laatste enqueuedgebeurtenis van de partitie wordt bijgehouden, bevat elke gebeurtenis die wordt ontvangen van de Event Hubs-service metagegevens over de partitie die anders niet het geval was. Dit resulteert in een klein extra verbruik van netwerkbandbreedte. Dit is over het algemeen een gunstige afweging wanneer het wordt overwogen om periodiek aanvragen voor partitie-eigenschappen te doen met behulp van de Event Hub-client.

trackLastEnqueuedEventProperties?: boolean

Waarde van eigenschap

boolean