EventPosition interface
表示事件中樞分割區中事件的位置,通常用於在 EventHubConsumerClient
上呼叫 subscribe()
方法,以指定分割區中要開始接收事件的位置。
若要取得代表數據流開頭或結尾的 EventPosition,請分別使用常數 earliestEventPosition
和 latestEventPosition
。
屬性
enqueued |
這個位置所識別之事件的UTC加入佇列時間。 以數位的形式提供時,這個值是 Unix Epoch 之後的毫秒數。 如果剛從序號或位移建立位置,則預期為未定義。 |
is |
指出指定的位移是否包含它所識別的事件。
只有在事件位置是由位移或序號所識別時,才會重發這項資訊。
預設值: |
offset | 這個位置所識別之事件的位移。 如果剛從序號或加入佇列的時間建立位置,則預期為未定義。 位移是數據分割內容中事件的相對位置。 位移不應視為穩定值。 相同的位移可能會參考不同的事件,因為事件達到保留期限制,而且不再顯示在分割區中。 |
sequence |
這個位置所識別之事件的序號。 如果剛從位移或加入佇列的時間建立位置,則預期為未定義。 |
屬性詳細資料
enqueuedOn
這個位置所識別之事件的UTC加入佇列時間。 以數位的形式提供時,這個值是 Unix Epoch 之後的毫秒數。 如果剛從序號或位移建立位置,則預期為未定義。
enqueuedOn?: number | Date
屬性值
number | Date
isInclusive
指出指定的位移是否包含它所識別的事件。
只有在事件位置是由位移或序號所識別時,才會重發這項資訊。
預設值:false
。
isInclusive?: boolean
屬性值
boolean
offset
這個位置所識別之事件的位移。 如果剛從序號或加入佇列的時間建立位置,則預期為未定義。
位移是數據分割內容中事件的相對位置。 位移不應視為穩定值。 相同的位移可能會參考不同的事件,因為事件達到保留期限制,而且不再顯示在分割區中。
offset?: number | "@latest"
屬性值
number | "@latest"
sequenceNumber
這個位置所識別之事件的序號。 如果剛從位移或加入佇列的時間建立位置,則預期為未定義。
sequenceNumber?: number
屬性值
number