EventData 類別

參考

EventData 類別是事件內容的容器。

繼承: builtins.object

EventData

建構函式

EventData(body: str | bytes | List | None = None)

參數

名稱	Description
body	str 或 bytes 要以單一訊息傳送的資料。 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]

參數

名稱	Description
encoding	str 用於解碼事件資料的編碼方式。預設值為 'UTF-8' 預設值: UTF-8

傳回

類型	Description
dict[str, any]	JSON 物件。

body_as_str

如果資料是相容的類型，則事件的內容為字串。

body_as_str(encoding: str = 'UTF-8') -> str

參數

名稱	Description
encoding	str 用於解碼事件資料的編碼方式。預設值為 'UTF-8' 預設值: UTF-8

傳回

類型	Description
str	事件的內容做為字串。

from_message_content

建立指定內容類型的 EventData 物件，以及要設定為主體的內容值。

from_message_content(content: bytes, content_type: str, **kwargs: Any) -> EventData

參數

名稱	Description
content 必要	bytes 要設定為訊息本文的內容值。
content_type 必要	str 要設定在訊息上的內容類型。

傳回

類型	Description
EventData	EventData 物件。

屬性

body

訊息的本文。格式可能會因本文類型而有所不同：針對 DATA ，本文可以是位元組或 Iterable[bytes]。針對 SEQUENCE ，本文可以是 List 或 Iterable[List]。針對 VALUE ，本文可以是任何類型的。

傳回

類型	Description
int, bool, float, bytes, str, dict, list, UUID

body_type

基礎 AMQP 訊息的本文類型。

傳回

類型	Description
AmqpMessageBodyType

content_type

內容類型描述元。選擇性地描述訊息的承載，並遵循第 5 節RFC2045格式的描述元，例如「application/json」。：rtype： str 或 None

correlation_id

相互關聯識別碼。允許應用程式指定訊息環境以供相互關聯之用，例如，反映正要回覆訊息的 MessageId。：rtype： str 或 None

enqueued_time

事件的排入佇列時間戳記。

傳回

類型	Description
datetime, None

message

取得基礎 uamqp。Message 或 LegacyMessage。這已被取代，將在更新版本中移除。

傳回

類型	Description
<xref:uamqp.Message>, <xref:LegacyMessage>

message_id

要識別訊息的識別碼。訊息識別碼是應用程式定義的值，可唯一識別訊息及其承載。識別碼是一個自由格式的字串，可以反映 GUID 或衍生自應用程式內容的識別碼。如果啟用，重複的偵測功能會識別並移除具有相同訊息識別碼的第二個和進一步提交訊息。：rtype： str 或 None

offset

事件的位移。

傳回

類型	Description
str, None

partition_key

事件的分割區索引鍵。

傳回

類型	Description
bytes, None

properties

事件上的應用程式定義屬性。

傳回

類型	Description
dict[str, any], dict[bytes, any]

raw_amqp_message

僅限進階使用方式。傳送或接收的內部 AMQP 訊息承載。

傳回

類型	Description
AmqpAnnotatedMessage

sequence_number

事件的序號。

傳回

類型	Description
int, None

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」 (個位元組)

傳回

類型	Description
dict[bytes, any]

共用方式為