ReceivedEventData interface
Интерфейс, описывающий структуру события, полученного из Концентратора событий.
Используйте это в качестве ссылки при создании функции processEvents
для обработки событий, полученных из Концентратора событий при использовании EventHubConsumerClient
.
Свойства
body | Текст сообщения, который должен быть отправлен или получен. |
content |
Тип контента сообщения. При необходимости описывает полезные данные сообщения с дескриптором после формата RFC2045, раздела 5, например application/json. |
correlation |
Идентификатор корреляции, позволяющий приложению указать контекст для сообщения в целях корреляции, например отражающий MessageId сообщения, на которое отвечает сообщение. |
enqueued |
Заквеченное время события. |
message |
Идентификатор сообщения — это определяемое приложением значение, которое однозначно идентифицирует сообщение и его полезные данные. |
offset | Смещение события. |
partition |
Когда указанный концентратор событий будет хэшировать его в partitionId. Это гарантирует, что сообщения в конечном итоге будут в определенной секции в концентраторе событий. |
properties | Определенные свойства приложения. |
sequence |
Порядковый номер события. |
system |
Свойства, заданные службой. |
Методы
get |
Возвращает базовое необработанное сообщение amqp. |
Сведения о свойстве
body
Текст сообщения, который должен быть отправлен или получен.
body: any
Значение свойства
any
contentType
Тип контента сообщения. При необходимости описывает полезные данные сообщения с дескриптором после формата RFC2045, раздела 5, например application/json.
contentType?: string
Значение свойства
string
correlationId
Идентификатор корреляции, позволяющий приложению указать контекст для сообщения в целях корреляции, например отражающий MessageId сообщения, на которое отвечает сообщение.
correlationId?: string | number | Buffer
Значение свойства
string | number | Buffer
enqueuedTimeUtc
Заквеченное время события.
enqueuedTimeUtc: Date
Значение свойства
Date
messageId
Идентификатор сообщения — это определяемое приложением значение, которое однозначно идентифицирует сообщение и его полезные данные.
messageId?: string | number | Buffer
Значение свойства
string | number | Buffer
offset
Смещение события.
offset: number
Значение свойства
number
partitionKey
Когда указанный концентратор событий будет хэшировать его в partitionId. Это гарантирует, что сообщения в конечном итоге будут в определенной секции в концентраторе событий.
partitionKey: null | string
Значение свойства
null | string
properties
Определенные свойства приложения.
properties?: {[key: string]: any}
Значение свойства
{[key: string]: any}
sequenceNumber
Порядковый номер события.
sequenceNumber: number
Значение свойства
number
systemProperties
Свойства, заданные службой.
systemProperties?: {[key: string]: any}
Значение свойства
{[key: string]: any}
Сведения о методе
getRawAmqpMessage()
Возвращает базовое необработанное сообщение amqp.
function getRawAmqpMessage(): AmqpAnnotatedMessage