你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
EventPosition interface
表示事件在事件中心分区中的位置,通常在调用 subscribe()
上的 EventHubConsumerClient
方法以指定分区中开始接收事件的位置时使用。
若要获取表示流的开始或结束的 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