你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
EventData 类
EventData 类是事件内容的容器。
- 继承
-
builtins.objectEventData
构造函数
EventData(body: str | bytes | List | None = None)
参数
名称 | 说明 |
---|---|
body
|
要以单个消息发送的数据。 body 可以是 str 或 bytes 的类型。 默认值: None
|
示例
创建 EventData 的实例
from azure.eventhub import EventData
event_data = EventData("String data")
event_data = EventData(b"Bytes data")
方法
body_as_json |
作为 JSON 对象加载的事件的内容(如果数据兼容)。 |
body_as_str |
如果数据属于兼容类型,则事件的内容为字符串。 |
from_message_content |
创建给定内容类型的 EventData 对象和要设置为正文的内容值。 |
body_as_json
作为 JSON 对象加载的事件的内容(如果数据兼容)。
body_as_json(encoding: str = 'UTF-8') -> Dict[str, Any]
参数
名称 | 说明 |
---|---|
encoding
|
用于解码事件数据的编码。 默认值为“UTF-8” 默认值: UTF-8
|
返回
类型 | 说明 |
---|---|
一个 JSON 对象。 |
body_as_str
如果数据属于兼容类型,则事件的内容为字符串。
body_as_str(encoding: str = 'UTF-8') -> str
参数
名称 | 说明 |
---|---|
encoding
|
用于解码事件数据的编码。 默认值为“UTF-8” 默认值: UTF-8
|
返回
类型 | 说明 |
---|---|
字符串形式的事件内容。 |
from_message_content
创建给定内容类型的 EventData 对象和要设置为正文的内容值。
from_message_content(content: bytes, content_type: str, **kwargs: Any) -> EventData
参数
名称 | 说明 |
---|---|
content
必需
|
要设置为消息正文的内容值。 |
content_type
必需
|
要对消息设置的内容类型。 |
返回
类型 | 说明 |
---|---|
EventData 对象。 |
属性
body
消息的正文。 格式可能因正文类型而异:对于 DATA,正文可以是字节或 Iterable[bytes]。 对于 SEQUENCE,正文可以是 List 或 Iterable[List]。 对于 VALUE,正文可以是任意类型。
返回
类型 | 说明 |
---|---|
int,
bool,
str,
dict,
list,
|
body_type
content_type
内容类型描述符。 (可选)描述消息的有效负载,其描述符遵循RFC2045第 5 节(例如“application/json”)的格式。 :rtype: str 或 None
correlation_id
相关标识符。 允许应用程序出于关联目的指定消息的上下文。例如,反映正在答复的消息的 MessageId。 :rtype: str 或 None
enqueued_time
message
获取基础 uamqp。Message 或 LegacyMessage。 它已弃用,将在更高版本中删除。
返回
类型 | 说明 |
---|---|
<xref:uamqp.Message>,
<xref:LegacyMessage>
|
message_id
用于标识消息的 ID。 消息标识符是应用程序定义的值,可用于唯一标识消息及其有效负载。 此标识符是自由格式字符串,可反映 GUID 或派生自应用程序上下文的标识符。 如果启用,重复检测功能将识别并删除具有相同消息 ID 的第二个和进一步提交的消息。:rtype: str 或 None
offset
partition_key
properties
raw_amqp_message
sequence_number
system_properties
由与事件关联的事件中心服务设置的元数据。
EventData 可能具有以下部分或全部元数据,具体取决于事件数据的源。
b“x-opt-sequence-number” (int)
b“x-opt-offset” (字节)
b“x-opt-partition-key” (字节)
b“x-opt-enqueued-time” (int)
b“message-id” (字节)
b“user-id” (字节)
b“to” (字节)
b“subject” (字节)
b“reply-to” (字节)
b“correlation-id” (字节)
b“content-type” (字节)
b“content-encoding” (字节)
b“absolute-expiry-time” (int)
b“creation-time” (int)
b“group-id” (字节)
b“group-sequence” (字节)
b“reply-to-group-id” (字节)
返回
类型 | 说明 |
---|---|