EventPosition interface

イベントハブパーティション内のイベントの位置を表します。通常は、で EventHubConsumerClient メソッドをsubscribe()呼び出して、イベントの受信を開始するパーティション内の位置を指定するときに使用されます。

ストリームの開始または終了を表す EventPosition を取得するには、それぞれ定数 earliestEventPosition と latestEventPosition を使用します。

プロパティ

enqueuedOn	この位置で識別されるイベントのエンキューされた時刻 (UTC)。数値として指定した場合、この値は Unix エポック以降のミリ秒数です。位置がシーケンス番号またはオフセットから作成された場合は、未定義であることが予想されます。
isInclusive	指定したオフセットが、それが識別するイベントを含むかどうかを示します。この情報は、イベント位置がオフセットまたはシーケンス番号によって識別された場合にのみ、relevent になります。既定値: `false`。
offset	この位置で識別されるイベントのオフセット。シーケンス番号またはエンキューされた時刻から位置が作成された場合は、未定義であることが予想されます。オフセットは、パーティションのコンテキストでのイベントの相対位置です。オフセットは安定した値とは見なさないでください。イベントが保持期間の制限に達し、パーティション内で表示されなくなったので、同じオフセットが別のイベントを参照する可能性があります。
sequenceNumber	この位置で識別されるイベントのシーケンス番号。位置がオフセットまたはエンキューされた時刻から作成されただけの場合は、未定義であることが予想されます。

この位置で識別されるイベントのエンキューされた時刻 (UTC)。数値として指定した場合、この値は Unix エポック以降のミリ秒数です。位置がシーケンス番号またはオフセットから作成された場合は、未定義であることが予想されます。

enqueuedOn?: number | Date

number | Date

指定したオフセットが、それが識別するイベントを含むかどうかを示します。この情報は、イベント位置がオフセットまたはシーケンス番号によって識別された場合にのみ、relevent になります。既定値: false。

isInclusive?: boolean

boolean

この位置で識別されるイベントのオフセット。シーケンス番号またはエンキューされた時刻から位置が作成された場合は、未定義であることが予想されます。

オフセットは、パーティションのコンテキストでのイベントの相対位置です。オフセットは安定した値とは見なさないでください。イベントが保持期間の制限に達し、パーティション内で表示されなくなったので、同じオフセットが別のイベントを参照する可能性があります。

offset?: number | "@latest"

number | "@latest"

この位置で識別されるイベントのシーケンス番号。位置がオフセットまたはエンキューされた時刻から作成されただけの場合は、未定義であることが予想されます。

sequenceNumber?: number

number