你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
EventDataBatch 类
一批事件。
在批处理中发送事件比发送单个事件的性能更高。 EventDataBatch 有助于创建 EventData 允许的最大大小批，以提高发送性能。
使用 add 方法添加事件，直到达到最大批大小限制（以字节为单位），此时将引发 ValueError 。 使用 send_batch 方法 EventHubProducerClient 或异步 EventHubProducerClient 进行发送。
请使用 EventHubProducerClient 的 create_batch 方法创建 EventDataBatch 对象，而不是直接实例化 EventDataBatch 对象。
警告：高度不建议在实例化 EventDataBatch 对象上更新实例变量max_size_in_bytes的值。 更新max_size_in_bytes值可能与事件中心服务允许的事件的最大大小冲突，并导致发送失败。
- 继承
-
builtins.objectEventDataBatch
构造函数
EventDataBatch(max_size_in_bytes: int | None = None, partition_id: str | None = None, partition_key: str | bytes | None = None, **kwargs: Any)参数
| 名称 | 说明 |
|---|---|
|
max_size_in_bytes
|
EventDataBatch 对象可以保存的最大字节数据大小。 默认值: None
|
|
partition_id
|
要发送到的特定分区 ID。 默认值: None
|
|
partition_key
|
使用给定partition_key，事件数据将发送到服务决定的事件中心的特定分区。 默认值: None
|
方法
| add |
尝试将 EventData 添加到批处理。 所添加事件的总大小是其正文、属性等的总和。如果此添加的大小导致批超出最大批大小，则会引发 ValueError 。 |
add
尝试将 EventData 添加到批处理。
所添加事件的总大小是其正文、属性等的总和。如果此添加的大小导致批超出最大批大小，则会引发 ValueError 。
add(event_data: EventData | AmqpAnnotatedMessage) -> None参数
| 名称 | 说明 |
|---|---|
|
event_data
必需
|
要添加到批处理的 EventData。 |
返回
| 类型 | 说明 |
|---|---|
属性
message
获取基础 uamqp。BatchMessage 或 LegacyBatchMessage。 它已弃用，将在更高版本中删除。
返回
| 类型 | 说明 |
|---|---|
|
<xref:uamqp.BatchMessage>,
<xref:LegacyBatchMessage>
|
