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 waarvandaan gebeurtenissen moeten worden ontvangen.

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

Eigenschappen

enqueuedOn	De enqueued tijd in UTC van de gebeurtenis die door deze positie wordt geïdentificeerd. Indien opgegeven als een getal is deze waarde het aantal milliseconden sinds het Unix-epoch. Naar verwachting niet gedefinieerd als de positie alleen is gemaakt op basis van een volgnummer of een verschuiving.
isInclusive	Geeft aan of de opgegeven offset inclusief de gebeurtenis is die wordt geïdentificeerd. Deze informatie wordt alleen opnieuw opgeslagen als de positie van de gebeurtenis is geïdentificeerd met een offset- of volgnummer. Standaardwaarde: false.
offset	De offset van de gebeurtenis die door deze positie wordt geïdentificeerd. De verwachting is niet gedefinieerd als de positie alleen is gemaakt op basis van een volgnummer of een gesemplementeerde tijd. De offset is de relatieve positie voor een gebeurtenis in de context van de partitie. De verschuiving moet niet worden beschouwd als een stabiele waarde. Dezelfde offset kan verwijzen naar een andere gebeurtenis omdat 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. De verwachting is niet gedefinieerd als de positie alleen is gemaakt op basis van een verschuiving of een gesempte tijd.

Eigenschapdetails

enqueuedOn

De enqueued tijd in UTC van de gebeurtenis die door deze positie wordt geïdentificeerd. Indien opgegeven als een getal is deze waarde het aantal milliseconden sinds het Unix-epoch. Naar verwachting niet gedefinieerd als de positie alleen is gemaakt op basis van een volgnummer of een verschuiving.

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 opgeslagen als de positie van de gebeurtenis is geïdentificeerd met een offset- of volgnummer. Standaardwaarde: false.

isInclusive?: boolean

Waarde van eigenschap

boolean

offset

De offset van de gebeurtenis die door deze positie wordt geïdentificeerd. De verwachting is niet gedefinieerd als de positie alleen is gemaakt op basis van een volgnummer of een gesemplementeerde tijd.

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

offset?: number | "@latest"

Waarde van eigenschap

number | "@latest"

sequenceNumber

Het volgnummer van de gebeurtenis die door deze positie wordt geïdentificeerd. De verwachting is niet gedefinieerd als de positie alleen is gemaakt op basis van een verschuiving of een gesempte tijd.

sequenceNumber?: number

Waarde van eigenschap

number