ServiceBusReceivedMessage interface
Описывает сообщение, полученное из служебной шины во время операций просмотра и поэтому не может быть решено.
- Extends
Свойства
dead |
Описание ошибки для недоставки сообщения. |
dead |
Причина взаимозапуска сообщения. |
dead |
Имя очереди или подписки, в которую было включено это сообщение, прежде чем оно было недоставлено. Только в сообщениях, которые были недоставлены и впоследствии автоматически переадресованы из подстроки недоставленной очереди в другую сущность. Указывает сущность, в которой сообщение было недоставлено. |
delivery |
Количество поставок, которые были предприняты для этого сообщения. Число увеличивается при истечении срока действия блокировки сообщения или сообщение явно отказывается с помощью метода |
enqueued |
Исходный порядковый номер сообщения. Для сообщений, которые были переадресованы автоматически, это свойство отражает порядковый номер, который сначала был назначен сообщению в исходной точке отправки. |
enqueued |
Момент UTC, в котором сообщение было принято и сохранено в служебной шине. |
expires |
Момент в формате UTC, в котором сообщение помечается для удаления и больше не доступно для извлечения из сущности из-за истечения срока действия. Это свойство вычисляется из 2 других свойств сообщения: |
locked |
Момент в формате UTC, пока сообщение не будет заблокировано в очереди или подписке.
По истечении срока действия блокировки
|
lock |
Маркер блокировки — это ссылка на блокировку, которая хранится брокером в режиме получения
|
sequence |
Уникальный номер, назначенный сообщению служебной шиной. Порядковый номер — это уникальное 64-разрядное целое число, назначенное сообщению, так как оно принимается и сохраняется брокером и функционирует в качестве его истинного идентификатора. Для секционированных сущностей самые верхние 16 бит отражают идентификатор секции. Порядковые числа монотонно увеличиваются. Они откатываются до 0, когда 48-64-разрядный диапазон исчерпан.
Максимальное безопасное целое число, которое в настоящее время поддерживает Javascript, |
state | Состояние сообщения может быть активным, отложенным или запланированным. Отложенные сообщения имеют отложенное состояние, запланированные сообщения имеют запланированное состояние, все остальные сообщения имеют активное состояние. |
Унаследованные свойства
application |
Определенные свойства приложения, которые можно использовать для пользовательских метаданных сообщения. |
body | Текст сообщения, который должен быть отправлен или получен. Если приложение, получающее сообщение, не использует этот пакет SDK, преобразуйте полезные данные тела в массив байтов или буфер для повышения совместимости между языками. |
content |
Тип контента сообщения. При необходимости описывает полезные данные сообщения с дескриптором после формата RFC2045, раздела 5, например application/json. |
correlation |
Идентификатор корреляции, позволяющий приложению указать контекст для сообщения в целях корреляции, например отражающий MessageId сообщения, на которое отвечает сообщение. См. маршрутизации сообщений и корреляции. |
message |
Идентификатор сообщения — это определяемое приложением значение, которое однозначно идентифицирует сообщение и его полезные данные. Примечание. Числа, которые не являются целыми целыми целыми числами, не допускаются. |
partition |
Ключ секции для отправки сообщения в секционированную сущность. Максимальная длина — 128 символов. Для секционированных сущностей, установка этого значения позволяет назначать связанные сообщения той же внутренней секции, чтобы порядок последовательности отправки был правильно записан. Секция выбирается хэш-функцией по этому значению и не может быть выбрана напрямую.
|
reply |
Адрес сущности для отправки ответов. Это необязательное и определяемое приложением значение — это стандартный способ выразить путь ответа получателю сообщения. Когда отправитель ожидает ответа, он задает значение абсолютного или относительного пути очереди или раздела, в который он ожидает отправки ответа. См. маршрутизации сообщений и корреляции. |
reply |
Идентификатор сеанса, расширяющий адрес |
scheduled |
Дата и время в формате UTC, в котором будет вложено сообщение. Это свойство возвращает время в формате UTC; При задании свойства указанное значение DateTime также должно находиться в формате UTC. Это значение предназначено для отложенной отправки сообщения. Он используется для задержки отправки сообщений в определенное время в будущем. Время выполнения сообщения не означает, что сообщение будет отправлено одновременно. Он будет помещен в очередь, но фактическое время отправки зависит от рабочей нагрузки очереди и его состояния. |
session |
Идентификатор сеанса для сущности, поддерживающей сеанс. Максимальная длина — 128 символов. Для сущностей, соответствующих сеансам, это определяемое приложением значение указывает принадлежность сеанса сообщения. Сообщения с тем же идентификатором сеанса подвергаются сводной блокировке и обеспечивают точную обработку в порядке и демультлексирование. Для сущностей, не соответствующих сеансам, это значение игнорируется. сеансах сообщений. |
subject | Метка конкретного приложения. Это свойство позволяет приложению указывать назначение сообщения получателю в стандартизованном режиме. мода, аналогичная строке темы электронной почты. Сопоставленное свойство AMQP — "subject". |
time |
Время жизни сообщения. Это значение является относительной длительностью, после которой истекает срок действия сообщения, начиная с момента принятия сообщения и хранения брокером, как записано в |
to | Адрес "to". Это свойство зарезервировано для дальнейшего использования в сценариях маршрутизации и в настоящее время игнорируется самим брокером. Приложения могут использовать это значение в сценариях, управляемых правилом, автоматической цепочке сценариях, чтобы указать предполагаемое логическое назначение сообщения. |
Сведения о свойстве
deadLetterErrorDescription
Описание ошибки для недоставки сообщения.
deadLetterErrorDescription?: string
Значение свойства
string
deadLetterReason
Причина взаимозапуска сообщения.
deadLetterReason?: string
Значение свойства
string
deadLetterSource
Имя очереди или подписки, в которую было включено это сообщение, прежде чем оно было недоставлено. Только в сообщениях, которые были недоставлены и впоследствии автоматически переадресованы из подстроки недоставленной очереди в другую сущность. Указывает сущность, в которой сообщение было недоставлено.
deadLetterSource?: string
Значение свойства
string
deliveryCount
Количество поставок, которые были предприняты для этого сообщения. Число увеличивается при истечении срока действия блокировки сообщения или сообщение явно отказывается с помощью метода abandon()
сообщения.
deliveryCount?: number
Значение свойства
number
enqueuedSequenceNumber
Исходный порядковый номер сообщения. Для сообщений, которые были переадресованы автоматически, это свойство отражает порядковый номер, который сначала был назначен сообщению в исходной точке отправки.
enqueuedSequenceNumber?: number
Значение свойства
number
enqueuedTimeUtc
Момент UTC, в котором сообщение было принято и сохранено в служебной шине.
enqueuedTimeUtc?: Date
Значение свойства
Date
expiresAtUtc
Момент в формате UTC, в котором сообщение помечается для удаления и больше не доступно для извлечения из сущности из-за истечения срока действия. Это свойство вычисляется из 2 других свойств сообщения: enqueuedTimeUtc
+ timeToLive
.
expiresAtUtc?: Date
Значение свойства
Date
lockedUntilUtc
Момент в формате UTC, пока сообщение не будет заблокировано в очереди или подписке.
По истечении срока действия блокировки deliveryCount
увеличивается, и сообщение снова доступно для получения.
- Неприменимо при получении сообщения в режиме получения
receiveAndDelete
. режим.
lockedUntilUtc?: Date
Значение свойства
Date
lockToken
Маркер блокировки — это ссылка на блокировку, которая хранится брокером в режиме получения peekLock
. Блокировки используются внутренне урегулировать сообщения, как описано в документации по продуктам более подробно
- Неприменимо при получении сообщения в режиме получения
receiveAndDelete
. режим.
lockToken?: string
Значение свойства
string
sequenceNumber
Уникальный номер, назначенный сообщению служебной шиной. Порядковый номер — это уникальное 64-разрядное целое число, назначенное сообщению, так как оно принимается и сохраняется брокером и функционирует в качестве его истинного идентификатора. Для секционированных сущностей самые верхние 16 бит отражают идентификатор секции. Порядковые числа монотонно увеличиваются. Они откатываются до 0, когда 48-64-разрядный диапазон исчерпан.
Максимальное безопасное целое число, которое в настоящее время поддерживает Javascript, 2^53 - 1
. Порядковый номер — это тип AMQP Long
, который может быть длинен до 64 битов. Чтобы представить, что мы используем библиотеку с именем long.js. Мы ожидаем, что клиенты будут использовать тип Long
, экспортируемый этой библиотекой.
sequenceNumber?: Long
Значение свойства
Long
state
Состояние сообщения может быть активным, отложенным или запланированным. Отложенные сообщения имеют отложенное состояние, запланированные сообщения имеют запланированное состояние, все остальные сообщения имеют активное состояние.
state: "active" | "deferred" | "scheduled"
Значение свойства
"active" | "deferred" | "scheduled"
Сведения об унаследованном свойстве
applicationProperties
Определенные свойства приложения, которые можно использовать для пользовательских метаданных сообщения.
applicationProperties?: {[key: string]: number | boolean | string | Date | null}
Значение свойства
{[key: string]: number | boolean | string | Date | null}
унаследован отServiceBusMessage.applicationProperties
body
Текст сообщения, который должен быть отправлен или получен. Если приложение, получающее сообщение, не использует этот пакет SDK, преобразуйте полезные данные тела в массив байтов или буфер для повышения совместимости между языками.
body: any
Значение свойства
any
унаследован отServiceBusMessage.body
contentType
Тип контента сообщения. При необходимости описывает полезные данные сообщения с дескриптором после формата RFC2045, раздела 5, например application/json.
contentType?: string
Значение свойства
string
наследуется отServiceBusMessage.contentType
correlationId
Идентификатор корреляции, позволяющий приложению указать контекст для сообщения в целях корреляции, например отражающий MessageId сообщения, на которое отвечает сообщение. См. маршрутизации сообщений и корреляции.
correlationId?: string | number | Buffer
Значение свойства
string | number | Buffer
наследуется отServiceBusMessage.correlationId
messageId
Идентификатор сообщения — это определяемое приложением значение, которое однозначно идентифицирует сообщение и его полезные данные.
Примечание. Числа, которые не являются целыми целыми целыми числами, не допускаются.
messageId?: string | number | Buffer
Значение свойства
string | number | Buffer
унаследовано отServiceBusMessage.messageId
partitionKey
Ключ секции для отправки сообщения в секционированную сущность. Максимальная длина — 128 символов. Для секционированных сущностей, установка этого значения позволяет назначать связанные сообщения той же внутренней секции, чтобы порядок последовательности отправки был правильно записан. Секция выбирается хэш-функцией по этому значению и не может быть выбрана напрямую.
- Для сущностей с поддержкой сеансов свойство
sessionId
переопределяет это значение. - Для несекционированных сущностей ключ секции будет игнорироваться
partitionKey?: string
Значение свойства
string
унаследовано отServiceBusMessage.partitionKey
replyTo
Адрес сущности для отправки ответов. Это необязательное и определяемое приложением значение — это стандартный способ выразить путь ответа получателю сообщения. Когда отправитель ожидает ответа, он задает значение абсолютного или относительного пути очереди или раздела, в который он ожидает отправки ответа. См. маршрутизации сообщений и корреляции.
replyTo?: string
Значение свойства
string
унаследовано отServiceBusMessage.replyTo
replyToSessionId
Идентификатор сеанса, расширяющий адрес replyTo
.
Максимальная длина — 128 символов. Это значение расширяет сведения ReplyTo и указывает, какой идентификатор сеанса должен быть задан для ответа при отправке сущности ответа.
См. маршрутизации сообщений и корреляции.
replyToSessionId?: string
Значение свойства
string
унаследован отServiceBusMessage.replyToSessionId
scheduledEnqueueTimeUtc
Дата и время в формате UTC, в котором будет вложено сообщение. Это свойство возвращает время в формате UTC; При задании свойства указанное значение DateTime также должно находиться в формате UTC. Это значение предназначено для отложенной отправки сообщения. Он используется для задержки отправки сообщений в определенное время в будущем. Время выполнения сообщения не означает, что сообщение будет отправлено одновременно. Он будет помещен в очередь, но фактическое время отправки зависит от рабочей нагрузки очереди и его состояния.
scheduledEnqueueTimeUtc?: Date
Значение свойства
Date
унаследовано отServiceBusMessage.scheduledEnqueueTimeUtc
sessionId
Идентификатор сеанса для сущности, поддерживающей сеанс. Максимальная длина — 128 символов. Для сущностей, соответствующих сеансам, это определяемое приложением значение указывает принадлежность сеанса сообщения. Сообщения с тем же идентификатором сеанса подвергаются сводной блокировке и обеспечивают точную обработку в порядке и демультлексирование. Для сущностей, не соответствующих сеансам, это значение игнорируется. сеансах сообщений.
sessionId?: string
Значение свойства
string
унаследован отServiceBusMessage.sessionId
subject
Метка конкретного приложения. Это свойство позволяет приложению указывать назначение сообщения получателю в стандартизованном режиме. мода, аналогичная строке темы электронной почты. Сопоставленное свойство AMQP — "subject".
subject?: string
Значение свойства
string
унаследован отServiceBusMessage.subject
timeToLive
Время жизни сообщения. Это значение является относительной длительностью, после которой истекает срок действия сообщения, начиная с момента принятия сообщения и хранения брокером, как записано в enqueuedTimeUtc
. Если значение не задано явным образом, предполагается, что значение DefaultTimeToLive для соответствующей очереди или раздела. Значение уровня сообщения timeToLive
не может быть больше, чем параметр DefaultTimeToLive сущности, и он автоматически корректируется, если это делает. См. срок действия.
timeToLive?: number
Значение свойства
number
унаследовано отServiceBusMessage.timeToLive
to
Адрес "to". Это свойство зарезервировано для дальнейшего использования в сценариях маршрутизации и в настоящее время игнорируется самим брокером. Приложения могут использовать это значение в сценариях, управляемых правилом, автоматической цепочке сценариях, чтобы указать предполагаемое логическое назначение сообщения.
to?: string
Значение свойства
string
унаследован отServiceBusMessage.to