Поделиться через

EventPosition interface

  • Ссылка
Пакет:
@azure/event-hubs

Представляет позицию события в секции концентратора событий, которая обычно используется при вызове subscribe() метода для EventHubConsumerClient , чтобы указать позицию в секции, откуда начинается получение событий.

Чтобы получить объект EventPosition, представляющий начало или конец потока, используйте константы earliestEventPosition и latestEventPosition соответственно.

Свойства

enqueuedOn

Время постановки в очередь в формате UTC события, определяемого данной позицией. Если указано в виде числа, это значение равно количеству миллисекунда с момента эпохи Unix. Ожидается, что позиция не определена, если позиция только что создана на основе порядкового номера или смещения.
isInclusive

Указывает, включает ли указанное смещение событие, которое оно идентифицирует. Эти сведения повторно передаются только в том случае, если позиция события была определена с помощью смещения или порядкового номера. Значение по умолчанию: false.
offset

Смещение события, определяемого данной позицией. Ожидается, что позиция не определена, если позиция только что создана из порядкового номера или времени постановки в очередь.

Смещение — это относительная позиция события в контексте секции. Смещение не должно считаться стабильным значением. Такое же смещение может ссылаться на другое событие, так как события достигают предельного срока хранения и больше не видны в секции.
sequenceNumber

Порядковый номер события, определяемого данной позицией. Ожидается, что позиция не определена, если позиция только что создана из смещения или времени постановки в очередь.

Сведения о свойстве

enqueuedOn

Время постановки в очередь в формате UTC события, определяемого данной позицией. Если указано в виде числа, это значение равно количеству миллисекунда с момента эпохи Unix. Ожидается, что позиция не определена, если позиция только что создана на основе порядкового номера или смещения.

enqueuedOn?: number | Date

Значение свойства

number | Date

isInclusive

Указывает, включает ли указанное смещение событие, которое оно идентифицирует. Эти сведения повторно передаются только в том случае, если позиция события была определена с помощью смещения или порядкового номера. Значение по умолчанию: false.

isInclusive?: boolean

Значение свойства

boolean

offset

Смещение события, определяемого данной позицией. Ожидается, что позиция не определена, если позиция только что создана из порядкового номера или времени постановки в очередь.

Смещение — это относительная позиция события в контексте секции. Смещение не должно считаться стабильным значением. Такое же смещение может ссылаться на другое событие, так как события достигают предельного срока хранения и больше не видны в секции.

offset?: number | "@latest"

Значение свойства

number | "@latest"

sequenceNumber

Порядковый номер события, определяемого данной позицией. Ожидается, что позиция не определена, если позиция только что создана из смещения или времени постановки в очередь.

sequenceNumber?: number

Значение свойства

number