你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ServiceBusMessageBatch 类

  • 参考

一批消息。

与发送单个消息相比，批量发送消息的性能更高。 ServiceBusMessageBatch 可帮助创建最大允许大小的 消息 批以提高发送性能。

使用 add 方法添加消息，直到达到最大批大小限制（以字节为单位），此时将引发 MessageSizeExceededError 。

请使用 ServiceBusSender 的 create_message_batch 方法创建 ServiceBusMessageBatch 对象，而不是直接实例化 ServiceBusMessageBatch 对象。

继承
builtins.object
ServiceBusMessageBatch

构造函数

ServiceBusMessageBatch(max_size_in_bytes: int | None = None, **kwargs: Any)

参数

名称 说明
max_size_in_bytes
Optional[int]

ServiceBusMessageBatch 对象可以容纳的最大字节数据大小。

默认值: None

方法

add_message

尝试将单个消息添加到批。

添加的消息的总大小是其正文、属性等的总和。如果此添加的大小导致批超出最大批大小，则将引发 MessageSizeExceededError 。

add_message

尝试将单个消息添加到批。

添加的消息的总大小是其正文、属性等的总和。如果此添加的大小导致批超出最大批大小，则将引发 MessageSizeExceededError 。

add_message(message: ServiceBusMessage | AmqpAnnotatedMessage | Mapping[str, Any]) -> None

参数

名称 说明
message
必需
Union[ServiceBusMessage, AmqpAnnotatedMessage]

要添加到批处理的消息。

例外

类型 说明
<xref:azure.servicebus.exceptions.MessageSizeExceededError>, <xref:when exceeding the size limit.>

属性

max_size_in_bytes

ServiceBusMessageBatch 对象可以容纳的最大字节数据大小。

返回

类型 说明
int

message

获取基础 uamqp。BatchMessage 或 LegacyBatchMessage。 它已弃用，将在更高版本中删除。

返回

类型 说明
<xref:uamqp.BatchMessage>,
<xref:LegacyBatchMessage>

size_in_bytes

批中消息的组合大小（以字节为单位）。

返回

类型 说明
int