EventData クラス

  • リファレンス

EventData クラスは、イベント コンテンツのコンテナーです。

継承
builtins.object
EventData

コンストラクター

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

パラメーター

名前 説明
body
str または bytes

1 つのメッセージで送信するデータ。 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
str

イベント データのデコードに使用するエンコード。 既定値は 'UTF-8' です

既定値: UTF-8

戻り値

型 説明
dict[str, any]

JSON オブジェクト。

body_as_str

データが互換性のある型の場合は、イベントの内容を文字列として指定します。

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

パラメーター

名前 説明
encoding
str

イベント データのデコードに使用するエンコード。 既定値は 'UTF-8' です

既定値: UTF-8

戻り値

型 説明
str

イベントの内容を文字列として指定します。

from_message_content

指定されたコンテンツ タイプと本文として設定するコンテンツ値を EventData オブジェクトを作成します。

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

パラメーター

名前 説明
content
必須
bytes

メッセージの本文として設定するコンテンツ値。
content_type
必須
str

メッセージに設定するコンテンツ タイプ。

戻り値

型 説明
EventData

EventData オブジェクト。

属性

body

メッセージの本文。 形式は、本文の種類によって異なる場合があります。 の場合 DATA、本文はバイトまたは Iterable[bytes] になります。 の場合 SEQUENCE、本文は List または Iterable[List]になります。 の場合 VALUE、本文には任意の型を指定できます。

戻り値

型 説明
int,
bool,
float,
bytes,
str,
dict,
list,
UUID

body_type

基になる AMQP メッセージの本文の種類。

戻り値

型 説明
AmqpMessageBodyType

content_type

コンテンツ タイプ記述子。 必要に応じて、メッセージのペイロードを記述します。記述子は、"application/json" など、RFC2045セクション 5 の形式に従います。 :rtype: str または None

correlation_id

関連付け識別子。 相関関係のために、アプリケーションがメッセージのコンテキストを指定できるようにします (たとえば、応答されるメッセージの MessageId を示すなど)。 :rtype: str または None

enqueued_time

イベントのエンキューされたタイムスタンプ。

戻り値

型 説明
datetime,
None

message

基になる uamqp を取得します。Message または LegacyMessage。 これは非推奨であり、今後のリリースで削除される予定です。

戻り値

型 説明
<xref:uamqp.Message>,
<xref:LegacyMessage>

message_id

メッセージを識別する ID。 メッセージ識別子は、アプリケーションによって定義される、メッセージとそのペイロードを一意に識別する値です。 この識別子は自由形式の文字列で、GUID またはアプリケーションのコンテキストから派生した識別子を反映することができます。 有効にした場合、重複検出機能は、同じメッセージ ID を持つメッセージの 2 つ目以降の送信を識別して削除します。:rtype: str または None

offset

イベントのオフセット。

戻り値

型 説明
str,
None

partition_key

イベントのパーティション キー。

戻り値

型 説明
bytes,
None

properties

イベントのアプリケーション定義プロパティ。

戻り値

型 説明
dict[str, any],
dict[bytes, any]

raw_amqp_message

高度な使用のみ。 送受信される内部 AMQP メッセージ ペイロード。

戻り値

型 説明
AmqpAnnotatedMessage

sequence_number

イベントのシーケンス番号。

戻り値

型 説明
int,
None

system_properties

イベントに関連付けられている Event Hubs Service によって設定されたメタデータ。

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" (バイト)

戻り値

型 説明
dict[bytes, any]