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)
參數
名稱 | Description |
---|---|
max_size_in_bytes
|
EventDataBatch 物件可以保存的最大位元組資料大小。 預設值: None
|
partition_id
|
要傳送至的特定資料分割識別碼。 預設值: None
|
partition_key
|
使用指定的partition_key,事件資料會傳送至服務所決定之事件中樞的特定分割區。 預設值: None
|
方法
add |
嘗試將 EventData 新增至批次。 新增事件的總大小是其主體、屬性等的總和。如果新增的大小導致批次超過批次大小上限,將會引發 ValueError 。 |
add
嘗試將 EventData 新增至批次。
新增事件的總大小是其主體、屬性等的總和。如果新增的大小導致批次超過批次大小上限,將會引發 ValueError 。
add(event_data: EventData | AmqpAnnotatedMessage) -> None
參數
名稱 | Description |
---|---|
event_data
必要
|
要新增至批次的 EventData。 |
傳回
類型 | Description |
---|---|
屬性
message
取得基礎 uamqp。BatchMessage 或 LegacyBatchMessage。 這是已被取代的,將會在較新的版本中移除。
傳回
類型 | Description |
---|---|
<xref:uamqp.BatchMessage>,
<xref:LegacyBatchMessage>
|