EventPosition interface

Paquet:

@azure/event-hubs

Représente la position d’un événement dans une partition Event Hub, généralement utilisée lors de l’appel de la subscribe() méthode sur un EventHubConsumerClient pour spécifier la position dans la partition à partir de laquelle commencer à recevoir des événements.

Pour obtenir une eventPosition représentant le début ou la fin du flux, utilisez les constantes earliestEventPosition et latestEventPosition respectivement.

Propriétés

enqueuedOn	Heure utc en file d’attente de l’événement identifié par cette position. Lorsqu’elle est fournie sous forme de nombre, cette valeur est le nombre de millisecondes depuis l’époque Unix. On s’attend à ce qu’elle ne soit pas définie si la position est simplement créée à partir d’un numéro de séquence ou d’un décalage.
isInclusive	Indique si le décalage spécifié comprend l’événement qu’il identifie. Ces informations ne sont valides que si la position de l’événement a été identifiée par un décalage ou un numéro de séquence. Valeur par défaut : false.
offset	Décalage de l’événement identifié par cette position. On s’attend à ce qu’elle ne soit pas définie si la position est créée à partir d’un numéro de séquence ou d’une heure en file d’attente. Le décalage est la position relative d’un événement dans le contexte de la partition. Le décalage ne doit pas être considéré comme une valeur stable. Le même décalage peut faire référence à un événement différent, car les événements atteignent la limite d’âge pour la rétention et ne sont plus visibles dans la partition.
sequenceNumber	Numéro de séquence de l’événement identifié par cette position. On s’attend à ce qu’elle ne soit pas définie si la position est créée à partir d’un décalage ou d’une heure en file d’attente.

Détails de la propriété

enqueuedOn

Heure utc en file d’attente de l’événement identifié par cette position. Lorsqu’elle est fournie sous forme de nombre, cette valeur est le nombre de millisecondes depuis l’époque Unix. On s’attend à ce qu’elle ne soit pas définie si la position est simplement créée à partir d’un numéro de séquence ou d’un décalage.

enqueuedOn?: number | Date

Valeur de propriété

number | Date

isInclusive

Indique si le décalage spécifié comprend l’événement qu’il identifie. Ces informations ne sont valides que si la position de l’événement a été identifiée par un décalage ou un numéro de séquence. Valeur par défaut : false.

isInclusive?: boolean

Valeur de propriété

boolean

offset

Décalage de l’événement identifié par cette position. On s’attend à ce qu’elle ne soit pas définie si la position est créée à partir d’un numéro de séquence ou d’une heure en file d’attente.

Le décalage est la position relative d’un événement dans le contexte de la partition. Le décalage ne doit pas être considéré comme une valeur stable. Le même décalage peut faire référence à un événement différent, car les événements atteignent la limite d’âge pour la rétention et ne sont plus visibles dans la partition.

offset?: number | "@latest"

Valeur de propriété

number | "@latest"

sequenceNumber

Numéro de séquence de l’événement identifié par cette position. On s’attend à ce qu’elle ne soit pas définie si la position est créée à partir d’un décalage ou d’une heure en file d’attente.

sequenceNumber?: number

Valeur de propriété

number