EventDataBatch interface
一个接口,表示可用于将事件发送到事件中心的一批事件。
若要创建批处理,请在 EventHubProducerClient
上使用 createBatch()
方法。
若要发送批处理,请使用同一客户端上的 sendBatch()
方法。
若要填充批处理,请使用批处理本身上的 tryAdd()
方法。
属性
count | 添加到批处理的事件数。 |
max |
批的最大大小(以字节为单位)。 如果正在添加的事件导致批的大小超过此限制,则批处理上的 |
size |
添加到批的事件被编码为单个 AMQP 消息后,批的大小(以字节为单位)。 |
方法
try |
如果批的大小限制允许,请将事件添加到批处理中。 注意:在再次调用此方法之前,请始终记得检查此方法的返回值。 |
属性详细信息
count
添加到批处理的事件数。
count: number
属性值
number
maxSizeInBytes
批的最大大小(以字节为单位)。 如果正在添加的事件导致批的大小超过此限制,则批处理上的 tryAdd
函数将返回 false
。 使用 EventHubProducerClient
上的 createBatch()
方法设置 maxSizeInBytes。
maxSizeInBytes: number
属性值
number
sizeInBytes
添加到批的事件被编码为单个 AMQP 消息后,批的大小(以字节为单位)。
sizeInBytes: number
属性值
number
方法详细信息
tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)
如果批的大小限制允许,请将事件添加到批处理中。 注意:在再次调用此方法之前,请始终记得检查此方法的返回值。
function tryAdd(eventData: EventData | AmqpAnnotatedMessage, options?: TryAddOptions): boolean
参数
- eventData
单个事件数据对象或 AmqpAnnotatedMessage。
- options
- TryAddOptions
返回
boolean
一个布尔值,该值指示事件数据是否已添加到批处理中。