ServiceBusMessage Класс

Сообщение служебной шины.

Наследование

builtins.object

ServiceBusMessage

Конструктор

ServiceBusMessage(body: str | bytes | None, *, application_properties: Dict[str | bytes, int | float | bytes | bool | str | UUID] | None = None, session_id: str | None = None, message_id: str | None = None, scheduled_enqueue_time_utc: datetime | None = None, time_to_live: timedelta | None = None, content_type: str | None = None, correlation_id: str | None = None, subject: str | None = None, partition_key: str | None = None, to: str | None = None, reply_to: str | None = None, reply_to_session_id: str | None = None, **kwargs: Any)

Параметры

body

Optional[Union[str, bytes]]

Обязательно

Данные, отправляемые в одном сообщении.

application_properties

Dict[str, Union[int или float или bool или bytes или str или UUID или datetime или None]]

Определяемые пользователем свойства сообщения.

session_id

Optional[str]

Идентификатор сеанса сообщения для сущности сеанса.

message_id

Optional[str]

Идентификатор для идентификации сообщения.

scheduled_enqueue_time_utc

Optional[datetime]

Время постановки в очередь сообщения в формате UTC.

time_to_live

Optional[timedelta]

Продолжительность жизни сообщения.

content_type

Optional[str]

Дескриптор типа контента.

correlation_id

Optional[str]

Идентификатор корреляции.

subject

Optional[str]

Тема конкретного приложения, иногда называемая меткой.

partition_key

Optional[str]

Ключ секции для отправки сообщения в секционированную сущность.

to

Optional[str]

Объект , используемый для auto_forward сценариев цепочки.

reply_to

Optional[str]

Адрес сущности, на который отправляются ответы.

reply_to_session_id

Optional[str]

Идентификатор сеанса, дополняющий адрес reply_to .

Примеры

Отправка сообщения с дополнительными свойствами

   message_send = ServiceBusMessage(
       "Hello World!!",
       session_id="MySessionID",
       application_properties={'data': 'custom_data'},
       time_to_live=datetime.timedelta(seconds=30),
       label='MyLabel'
   )

Атрибуты

application_properties

Определяемые пользователем свойства сообщения.

Возвращаемый тип

dict[str,

bytes, <xref:PrimitiveTypes>],

None

body

Текст сообщения. Формат может отличаться в зависимости от типа текста: для DATA— текст может быть байтами или итерируемыми[байтами]. Для SEQUENCEможет быть указан текст List или Iterable[List]. Для VALUEтекст может быть любого типа.

Возвращаемый тип

Any

body_type

Тип текста базового сообщения AMQP.

Возвращаемый тип

AmqpMessageBodyType

content_type

Дескриптор типа контента.

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

Возвращаемый тип

str,

None

correlation_id

Идентификатор корреляции.

Позволяет приложению указать контекст сообщения для корреляции, например MessageId сообщения, для которого предоставляется ответ.

См. статью Маршрутизация и корреляция сообщений в https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Возвращаемый тип

str,

None

message

Получите базовый uamqp. Message или LegacyMessage. Это не рекомендуется и будет удалено в более позднем выпуске.

Возвращаемый тип

<xref:uamqp.Message>,

<xref:LegacyMessage>

message_id

Идентификатор для идентификации сообщения.

Идентификатор сообщения — это определяемое приложением значение, позволяющее уникально идентифицировать сообщение и его полезные данные. Идентификатор — это строка в свободной форме, которая может отразить глобальный уникальный идентификатор или идентификатор, производный от контекста приложения. Если этот параметр включен, функция обнаружения дубликатов (см. https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) определяет и удаляет вторую и дальнейшую отправку сообщений с тем же идентификатором сообщения.

Возвращаемый тип

str,

None

partition_key

Ключ секции для отправки сообщения в секционированную сущность.

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

См. раздел Секционированные очереди и разделы в https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning.

Возвращаемый тип

str,

None

raw_amqp_message

Только расширенное использование. Отправленные или полученные внутренние полезные данные сообщения AMQP. :rtype: ~azure.servicebus.amqp.AmqpAnnotatedMessage

reply_to

Адрес сущности, на который отправляются ответы.

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

См. статью Маршрутизация и корреляция сообщений в https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Возвращаемый тип

str,

None

reply_to_session_id

Идентификатор сеанса, дополняющий адрес reply_to .

Это значение дополняет сведения о reply_to и указывает, какой идентификатор сеанса следует задать для ответа при отправке сущности ответа.

См. статью Маршрутизация и корреляция сообщений в https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Возвращаемый тип

str,

None

scheduled_enqueue_time_utc

Время постановки в очередь сообщения в формате UTC.

Это свойство можно использовать для планирования отправки сообщения с помощью метода ServiceBusSender.send . Если требуется отмена запланированных сообщений, следует использовать метод ServiceBusSender.schedule , который возвращает порядковые номера, которые можно использовать для будущей отмены. scheduled_enqueue_time_utc значение Нет, если не задано.

Возвращаемый тип

datetime

session_id

Идентификатор сеанса сообщения для сущности сеанса.

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

См. раздел Сеансы сообщений в https://docs.microsoft.com/azure/service-bus-messaging/message-sessions.

Возвращаемый тип

str,

None

subject

Тема конкретного приложения, иногда называемая меткой.

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

Возвращаемый тип

str

time_to_live

Продолжительность жизни сообщения.

Это значение представляет собой относительную длительность, по истечении которой истекает срок действия сообщения, начиная с момента принятия и сохранения сообщения брокером, как записано в enqueued_time_utc. Если не задано явно, для соответствующей очереди или раздела используется значение DefaultTimeToLive. Значение времени жизни на уровне сообщения не может быть длиннее, чем значение времени жизни сущности, и оно автоматически корректируется, если это так.

См. раздел Истечение срока действия в https://docs.microsoft.com/azure/service-bus-messaging/message-expiration

Возвращаемый тип

timedelta

to

Объект , на который нужно обращаться .

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

Дополнительные сведения см. в статье https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding.

Возвращаемый тип

str,

None