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 méthode subscribe() sur un EventHubConsumerClient pour spécifier la position dans la partition pour commencer à recevoir des événements.

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

Propriétés

enqueuedOn	Heure en file d’attente utc de l’événement identifié par cette position. Lorsqu’elle est fournie en tant que 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 créée à partir d’un numéro de séquence ou d’un décalage.
isInclusive	Indique si le décalage spécifié est inclus dans l’événement qu’il identifie. Ces informations s’appliquent uniquement 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 mise 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 vient d’être créée à partir d’un décalage ou d’une heure mise en file d’attente.

Détails de la propriété

enqueuedOn

Heure en file d’attente utc de l’événement identifié par cette position. Lorsqu’elle est fournie en tant que 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 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é est inclus dans l’événement qu’il identifie. Ces informations s’appliquent uniquement 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 mise 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?: string

Valeur de propriété

string

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 vient d’être créée à partir d’un décalage ou d’une heure mise en file d’attente.

sequenceNumber?: number

Valeur de propriété

number