EventPosition interface

Paket:

@azure/event-hubs

Stellt die Position eines Ereignisses in einer Event Hub-Partition dar, die normalerweise beim Aufrufen der subscribe() -Methode für ein 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 in die Warteschlange eingereihte Uhrzeit in UTC des durch diese Position identifizierten Ereignisses. Wenn dieser Wert als Zahl angegeben wird, ist dieser Wert die Anzahl von Millisekunden seit der Unix-Epoche. Es wird erwartet, dass sie nicht definiert ist, wenn die Position nur aus einer Sequenznummer oder einem Offset erstellt wird.
isInclusive	Gibt an, ob der angegebene Offset mit dem Ereignis, das er identifiziert, enthalten ist. Diese Informationen sind nur relevent, wenn die Ereignisposition durch einen Offset oder eine 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 nur aus einer Sequenznummer oder einer in die Warteschlange gestellten 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. Derselbe Offset kann sich auf ein anderes Ereignis beziehen, da Ereignisse die Altersgrenze für die Aufbewahrung erreichen und nicht mehr innerhalb der Partition sichtbar sind.
sequenceNumber	Die Sequenznummer des Ereignisses, das durch diese Position identifiziert wird. Es wird erwartet, dass sie nicht definiert ist, wenn die Position nur aus einer Offset- oder Queuedzeit erstellt wird.

Details zur Eigenschaft

enqueuedOn

Die in die Warteschlange eingereihte Uhrzeit in UTC des durch diese Position identifizierten Ereignisses. Wenn dieser Wert als Zahl angegeben wird, ist dieser Wert die Anzahl von Millisekunden seit der Unix-Epoche. Es wird erwartet, dass sie nicht definiert ist, wenn die Position nur aus einer Sequenznummer oder einem Offset erstellt wird.

enqueuedOn?: number | Date

Eigenschaftswert

number | Date

isInclusive

Gibt an, ob der angegebene Offset mit dem Ereignis, das er identifiziert, enthalten ist. Diese Informationen sind nur relevent, wenn die Ereignisposition durch einen Offset oder eine 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 nur aus einer Sequenznummer oder einer in die Warteschlange gestellten 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. Derselbe Offset kann sich auf ein anderes Ereignis beziehen, 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 Ereignisses, das durch diese Position identifiziert wird. Es wird erwartet, dass sie nicht definiert ist, wenn die Position nur aus einer Offset- oder Queuedzeit erstellt wird.

sequenceNumber?: number

Eigenschaftswert

number