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

ServiceBusReceivedMessage interface

  • Ссылка
Пакет:
@azure/service-bus

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

Extends
ServiceBusMessage

Свойства

deadLetterErrorDescription

Описание ошибки для недоставленных сообщений.
deadLetterReason

Причина недоставления сообщения.
deadLetterSource

Имя очереди или подписки, в которую было помещено это сообщение в очередь, до того, как оно было отправлено в очередь. Задается только в сообщениях, которые были недоставлены и впоследствии автоматически переадресованы из вложенной очереди недоставленных сообщений в другую сущность. Указывает сущность, в которой сообщения перешли в состояние недоставленных.
deliveryCount

Количество попыток доставки этого сообщения. Счетчик увеличивается по истечении срока действия блокировки сообщения или при явном отказе от сообщения с помощью abandon() метода в сообщении.
enqueuedSequenceNumber

Исходный порядковый номер сообщения. Для автоматически пересланных сообщений это свойство отражает порядковый номер, который был присвоен сообщению в исходной точке отправки.
enqueuedTimeUtc

Момент в формате UTC, в котором сообщение было принято и сохранено в служебной шине.
expiresAtUtc

Время в формате UTC, когда сообщение было помечено для удаления и стало недоступным для извлечения из сущности из-за истечения срока действия. Это свойство вычисляется из двух других свойств сообщения: enqueuedTimeUtc + timeToLive.
lockedUntilUtc

Момент времени в формате UTC, до которого сообщение будет заблокировано в очереди или подписке. По истечении срока действия блокировки увеличивается, deliveryCount и сообщение снова становится доступным для извлечения.

  • Неприменимо, если сообщение получено в receiveAndDelete режиме получения. .
lockToken

Маркер блокировки — это ссылка на блокировку, удерживаемую брокером в peekLock режиме получения. Блокировки используются для внутреннего урегулирования сообщений, как описано в документации по продукту более подробно.

  • Неприменимо, если сообщение получено в receiveAndDelete режиме получения. .
sequenceNumber

Уникальный номер, назначенный сообщению служебной шиной. Порядковый номер — это уникальное 64-битное целое число, присваиваемое сообщению, когда его принимает и сохраняет брокер, которое выступает в качестве правильного идентификатора. Для секционированных сущностей верхние 16 бит отражают идентификатор раздела. Порядковые номера монотонно увеличиваются. Когда диапазон 48–64 бит исчерпан, используется значение 0.

Максимальное безопасное целое число, которое в настоящее время поддерживает JavaScript, — .2^53 - 1 Порядковый номер — это тип AMQP Long , который может иметь длину до 64 бит. Чтобы представить, что мы используем библиотеку с именемlong.js. Мы ожидаем, что клиенты будут использовать Long тип, экспортируемый этой библиотекой.
state

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

Унаследованные свойства

applicationProperties

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

Текст сообщения, который должен быть отправлен или получен. Если приложение, получающее сообщение, не использует этот пакет SDK, преобразуйте полезные данные тела в массив байтов или буфер для лучшей совместимости между языками.
contentType

Тип содержимого сообщения. При необходимости описывает полезные данные сообщения с дескриптором в формате RFC2045, раздел 5, например "application/json".
correlationId

Идентификатор корреляции, позволяющий приложению указать контекст сообщения в целях корреляции, например отражая MessageId сообщения, на которое отправляется ответ. См. статью Маршрутизация и корреляция сообщений.
messageId

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

Примечание. Числа, которые не являются целыми целыми числами, не допускаются.
partitionKey

Ключ секции для отправки сообщения в секционированную сущность. Максимальная длина — 128 символов. Для секционированных сущностей установка этого значения позволяет назначить связанные сообщения тому же внутреннему разделу, чтобы порядок последовательности отправки был правильно записан. Раздел выбирается с помощью хэш-функции этого значения. Его нельзя выбрать напрямую.

  • Для сущностей, поддерживающих сеанс, sessionId свойство переопределяет это значение.
  • Для несекционированных сущностей ключ секции будет игнорироваться.
replyTo

Адрес сущности, на который отправляются ответы. Это необязательное значение, определяемое приложением, является стандартным способом выражения пути ответа для получателя сообщения. Когда отправитель ожидает ответа, он присваивает значение абсолютному или относительному пути очереди или раздела, куда будет отправлен ответ. См. статью Маршрутизация и корреляция сообщений.
replyToSessionId

Идентификатор сеанса replyTo , дополняющий адрес. Максимальная длина — 128 символов. Это значение расширяет сведения ReplyTo и указывает, какой SessionId должен быть задан для ответа при отправке в сущность ответа. См. статью Маршрутизация и корреляция сообщений.
scheduledEnqueueTimeUtc

Дата и время в формате UTC, когда сообщение будет помещено в очередь. Это свойство возвращает время в формате UTC; При задании свойства указанное значение DateTime также должно быть в формате UTC. Это значение для отложенной отправки сообщений. Он используется для задержки отправки сообщений в определенное время в будущем. Время постановки в очередь сообщения не означает, что сообщение будет отправлено одновременно. Он будет помещен в очередь, но фактическое время отправки зависит от рабочей нагрузки очереди и ее состояния.
sessionId

Идентификатор сеанса для сущности, поддерживающей сеанс. Максимальная длина — 128 символов. Для сущностей, учитывающих сеансы, это значение, определяемое приложением, указывает принадлежность сеанса сообщения. В сообщениях с одинаковым идентификатором сеанса может быть заблокирована сводка и включена точная порядковая обработка и демультиплексирование. Для сущностей, не учитывающих сеансы, это значение игнорируется. Сеансы сообщений.
subject

Метка конкретного приложения. Это свойство позволяет приложению указать назначение сообщения получателю в стандартизованном формате. мода, аналогично строке темы электронной почты. Сопоставленное свойство AMQP — "subject".
timeToLive

Значение времени жизни сообщения. Это значение представляет собой относительную длительность, по истечении которой истекает срок действия сообщения, начиная с момента принятия сообщения и сохранения брокером, как записано в enqueuedTimeUtc. Если не задано явно, для соответствующей очереди или раздела используется значение DefaultTimeToLive. Значение уровня timeToLive сообщения не может быть длиннее, чем значение DefaultTimeToLive сущности, и оно настраивается автоматически, если это так. См. раздел Срок действия.
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, когда сообщение было помечено для удаления и стало недоступным для извлечения из сущности из-за истечения срока действия. Это свойство вычисляется из двух других свойств сообщения: enqueuedTimeUtc + timeToLive.

expiresAtUtc?: Date

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

Date

lockedUntilUtc

Момент времени в формате UTC, до которого сообщение будет заблокировано в очереди или подписке. По истечении срока действия блокировки увеличивается, deliveryCount и сообщение снова становится доступным для извлечения.

  • Неприменимо, если сообщение получено в receiveAndDelete режиме получения. .
lockedUntilUtc?: Date

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

Date

lockToken

Маркер блокировки — это ссылка на блокировку, удерживаемую брокером в peekLock режиме получения. Блокировки используются для внутреннего урегулирования сообщений, как описано в документации по продукту более подробно.

  • Неприменимо, если сообщение получено в receiveAndDelete режиме получения. .
lockToken?: string

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

string

sequenceNumber

Уникальный номер, назначенный сообщению служебной шиной. Порядковый номер — это уникальное 64-битное целое число, присваиваемое сообщению, когда его принимает и сохраняет брокер, которое выступает в качестве правильного идентификатора. Для секционированных сущностей верхние 16 бит отражают идентификатор раздела. Порядковые номера монотонно увеличиваются. Когда диапазон 48–64 бит исчерпан, используется значение 0.

Максимальное безопасное целое число, которое в настоящее время поддерживает 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 и указывает, какой SessionId должен быть задан для ответа при отправке в сущность ответа. См. статью Маршрутизация и корреляция сообщений.

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