SubscribeOptions interface

Pakket:

@azure/event-hubs

Opties voor het configureren van de methode subscribe 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 hoeveelheid tijd die moet worden gewacht om het aangevraagde aantal berichten op te bouwen voordat de gegevens worden doorgegeven aan gebruikerscode voor verwerking. Indien niet opgegeven, wordt deze standaard ingesteld op 60 seconden.
ownerLevel	Het niveau van de eigenaar dat moet worden gebruikt als dit abonnement zich abonneert op partities.
prefetchCount	Het aantal gebeurtenissen dat gretig wordt aangevraagd en in de wachtrij wordt geplaatst, ongeacht of een leesbewerking is aangevraagd.
skipParsingBodyAsJson	Optie om de client uit te schakelen voor het uitvoeren van JSON.parse() in de berichttekst wanneer het bericht wordt ontvangen. Niet van toepassing als het bericht is verzonden met de waarde of reeks van het hoofdteksttype AMQP. Gebruik deze optie als u liever rechtstreeks met de bytes in de berichttekst werkt dan dat de client deze probeert te parseren.
startPosition	De gebeurtenispositie in een partitie om gebeurtenissen te ontvangen van als er geen controlepunt wordt gevonden. Geef een toewijzing van de partitie-id door aan positie als u voor elke partitie een andere beginpositie wilt gebruiken.
tracingOptions	Opties voor het configureren van tracering.
trackLastEnqueuedEventProperties	Hiermee wordt aangegeven of de consument informatie moet aanvragen over de laatste enqueuedgebeurtenis op de bijbehorende partitie en die 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 zou worden gebruikt. Dit resulteert in een kleine hoeveelheid extra verbruik van netwerkbandbreedte die over het algemeen een gunstige afweging is wanneer wordt overwogen tegen het periodiek indienen van aanvragen voor partitie-eigenschappen 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 hoeveelheid tijd die moet worden gewacht om het aangevraagde aantal berichten op te bouwen voordat de gegevens worden doorgegeven aan gebruikerscode voor verwerking. Indien niet opgegeven, wordt deze standaard ingesteld op 60 seconden.

maxWaitTimeInSeconds?: number

Waarde van eigenschap

number

ownerLevel

Het niveau van de eigenaar dat moet worden gebruikt als dit abonnement zich abonneert op partities.

ownerLevel?: number

Waarde van eigenschap

number

prefetchCount

Het aantal gebeurtenissen dat gretig wordt aangevraagd en in de wachtrij wordt geplaatst, ongeacht 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() in de berichttekst wanneer het bericht wordt ontvangen. Niet van toepassing als het bericht is verzonden met de waarde of reeks van het hoofdteksttype AMQP. Gebruik deze optie als u liever rechtstreeks met de bytes in de berichttekst werkt dan dat de client deze probeert te parseren.

skipParsingBodyAsJson?: boolean

Waarde van eigenschap

boolean

startPosition

De gebeurtenispositie in een partitie om gebeurtenissen te ontvangen van als er geen controlepunt wordt gevonden. Geef een toewijzing van de partitie-id door aan positie als u voor elke partitie een andere beginpositie 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 informatie moet aanvragen over de laatste enqueuedgebeurtenis op de bijbehorende partitie en die 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 zou worden gebruikt. Dit resulteert in een kleine hoeveelheid extra verbruik van netwerkbandbreedte die over het algemeen een gunstige afweging is wanneer wordt overwogen tegen het periodiek indienen van aanvragen voor partitie-eigenschappen met behulp van de Event Hub-client.

trackLastEnqueuedEventProperties?: boolean

Waarde van eigenschap

boolean