EventPosition interface

Pakket:

@azure/event-hubs

Vertegenwoordigt de positie van een gebeurtenis in een Event Hub-partitie, die doorgaans wordt gebruikt bij het aanroepen van de subscribe() methode op een EventHubConsumerClient om de positie in de partitie op te geven waaruit gebeurtenissen moeten worden ontvangen.

Als u een EventPosition wilt ophalen die het begin of einde van de stream aangeeft, gebruikt u respectievelijk de constanten earliestEventPosition en latestEventPosition.

Eigenschappen

enqueuedOn	De tijd die is geïnventueerd in UTC van de gebeurtenis die door deze positie is geïdentificeerd. Wanneer deze waarde als een getal wordt opgegeven, is dit het aantal milliseconden sinds de Unix Epoch. Verwacht wordt dat deze niet gedefinieerd is als de positie zojuist is gemaakt op basis van een volgnummer of een offset.
isInclusive	Geeft aan of de opgegeven offset inclusief de gebeurtenis is die wordt geïdentificeerd. Deze informatie wordt alleen opnieuw uitgevoerd als de gebeurtenispositie is geïdentificeerd door een offset- of volgnummer. Standaardwaarde: false.
offset	De verschuiving van de gebeurtenis die door deze positie is geïdentificeerd. Verwacht wordt dat deze niet gedefinieerd is als de positie zojuist is gemaakt op basis van een volgnummer of een enqueuedtijd. De offset is de relatieve positie voor een gebeurtenis in de context van de partitie. De verschuiving mag niet als een stabiele waarde worden beschouwd. Dezelfde offset kan verwijzen naar een andere gebeurtenis wanneer gebeurtenissen de leeftijdslimiet voor retentie bereiken en niet meer zichtbaar zijn binnen de partitie.
sequenceNumber	Het volgnummer van de gebeurtenis die door deze positie wordt geïdentificeerd. Verwacht wordt dat deze niet gedefinieerd is als de positie zojuist wordt gemaakt op basis van een offset- of enqueuedtijd.

Eigenschapdetails

enqueuedOn

De tijd die is geïnventueerd in UTC van de gebeurtenis die door deze positie is geïdentificeerd. Wanneer deze waarde als een getal wordt opgegeven, is dit het aantal milliseconden sinds de Unix Epoch. Verwacht wordt dat deze niet gedefinieerd is als de positie zojuist is gemaakt op basis van een volgnummer of een offset.

enqueuedOn?: number | Date

Waarde van eigenschap

number | Date

isInclusive

Geeft aan of de opgegeven offset inclusief de gebeurtenis is die wordt geïdentificeerd. Deze informatie wordt alleen opnieuw uitgevoerd als de gebeurtenispositie is geïdentificeerd door een offset- of volgnummer. Standaardwaarde: false.

isInclusive?: boolean

Waarde van eigenschap

boolean

offset

De verschuiving van de gebeurtenis die door deze positie is geïdentificeerd. Verwacht wordt dat deze niet gedefinieerd is als de positie zojuist is gemaakt op basis van een volgnummer of een enqueuedtijd.

De offset is de relatieve positie voor een gebeurtenis in de context van de partitie. De verschuiving mag niet als een stabiele waarde worden beschouwd. Dezelfde offset kan verwijzen naar een andere gebeurtenis wanneer gebeurtenissen de leeftijdslimiet voor retentie bereiken en niet meer zichtbaar zijn binnen de partitie.

offset?: string

Waarde van eigenschap

string

sequenceNumber

Het volgnummer van de gebeurtenis die door deze positie wordt geïdentificeerd. Verwacht wordt dat deze niet gedefinieerd is als de positie zojuist wordt gemaakt op basis van een offset- of enqueuedtijd.

sequenceNumber?: number

Waarde van eigenschap

number