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?: string

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

string

sequenceNumber

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

sequenceNumber?: number

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

number