EventPosition interface

Paket:

@azure/event-hubs

Stellt die Position eines Ereignisses in einer Event Hub-Partition dar, die in der Regel beim Aufrufen der subscribe() -Methode für eine EventHubConsumerClient verwendet wird, um die Position in der Partition anzugeben, von der ereignisse empfangen werden sollen.

Um eine EventPosition abzurufen, die den Anfang oder das Ende des Datenstroms darstellt, verwenden Sie die Konstanten earliestEventPosition bzw. latestEventPosition.

Eigenschaften

enqueuedOn	Die durch diese Position identifizierte Zeit in UTC des Ereignisses. Bei Angabe als Zahl ist dieser Wert die Anzahl von Millisekunden seit der Unix-Epoche. Es wird erwartet, dass sie nicht definiert ist, wenn die Position gerade aus einer Sequenznummer oder einem Offset erstellt wird.
isInclusive	Gibt an, ob der angegebene Offset inklusive des Ereignisses ist, das es identifiziert. Diese Informationen sind nur relevent, wenn die Ereignisposition durch eine Offset- oder Sequenznummer identifiziert wurde. Standardwert: false.
offset	Der Offset des durch diese Position identifizierten Ereignisses. Es wird erwartet, dass sie nicht definiert ist, wenn die Position gerade aus einer Sequenznummer oder einer enqueuierten Zeit erstellt wird. Der Offset ist die relative Position für ein Ereignis im Kontext der Partition. Der Offset sollte nicht als stabiler Wert betrachtet werden. Der gleiche Offset kann auf ein anderes Ereignis verweisen, da Ereignisse die Altersgrenze für die Aufbewahrung erreichen und nicht mehr innerhalb der Partition sichtbar sind.
sequenceNumber	Die Sequenznummer des durch diese Position identifizierten Ereignisses. Es wird erwartet, dass sie nicht definiert ist, wenn die Position gerade aus einem Offset oder einer Queuedzeit erstellt wird.

Details zur Eigenschaft

enqueuedOn

Die durch diese Position identifizierte Zeit in UTC des Ereignisses. Bei Angabe als Zahl ist dieser Wert die Anzahl von Millisekunden seit der Unix-Epoche. Es wird erwartet, dass sie nicht definiert ist, wenn die Position gerade aus einer Sequenznummer oder einem Offset erstellt wird.

enqueuedOn?: number | Date

Eigenschaftswert

number | Date

isInclusive

Gibt an, ob der angegebene Offset inklusive des Ereignisses ist, das es identifiziert. Diese Informationen sind nur relevent, wenn die Ereignisposition durch eine Offset- oder Sequenznummer identifiziert wurde. Standardwert: false.

isInclusive?: boolean

Eigenschaftswert

boolean

offset

Der Offset des durch diese Position identifizierten Ereignisses. Es wird erwartet, dass sie nicht definiert ist, wenn die Position gerade aus einer Sequenznummer oder einer enqueuierten Zeit erstellt wird.

Der Offset ist die relative Position für ein Ereignis im Kontext der Partition. Der Offset sollte nicht als stabiler Wert betrachtet werden. Der gleiche Offset kann auf ein anderes Ereignis verweisen, da Ereignisse die Altersgrenze für die Aufbewahrung erreichen und nicht mehr innerhalb der Partition sichtbar sind.

offset?: number | "@latest"

Eigenschaftswert

number | "@latest"

sequenceNumber

Die Sequenznummer des durch diese Position identifizierten Ereignisses. Es wird erwartet, dass sie nicht definiert ist, wenn die Position gerade aus einem Offset oder einer Queuedzeit erstellt wird.

sequenceNumber?: number

Eigenschaftswert

number