مشاركة عبر

EventData الفصل

  • ‏‏المرجع

فئة EventData هي حاوية لمحتوى الحدث.

توريث
builtins.object
EventData

الدالمنشئ

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

المعلمات

الاسم الوصف
body
str أو bytes

البيانات المراد إرسالها في رسالة واحدة. يمكن أن يكون الجسم نوع من str أو بايت.

القيمة الافتراضية: 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إلى ، يمكن أن يكون النص الأساسي بايت أو قابلا لل تكرار[بايت]. بالنسبة SEQUENCEإلى ، يمكن أن يكون النص الأساسي List أو Iterable[List]. بالنسبة إلى VALUE، يمكن أن يكون الجسم أي نوع.

المرتجعات

النوع الوصف
int,
bool,
float,
bytes,
str,
dict,
list,
UUID

body_type

نوع النص الأساسي لرسالة AMQP الأساسية.

المرتجعات

النوع الوصف
AmqpMessageBodyType

content_type

واصف نوع المحتوى. يصف اختياريا حمولة الرسالة، مع واصف يتبع تنسيق RFC2045، القسم 5، على سبيل المثال "application/json". :rtype: str أو None

correlation_id

معرف الارتباط. يسمح للتطبيق بتحديد سياق للرسالة لأغراض الارتباط، على سبيل المثال يعكس MessageId لرسالة يتم الرد عليها. :rtype: str أو None

enqueued_time

الطابع الزمني المحدد للحدث.

المرتجعات

النوع الوصف
datetime,
None

message

احصل على uamqp الأساسي. الرسالة أو LegacyMessage. هذا مهمل وسيتم إزالته في إصدار لاحق.

المرتجعات

النوع الوصف
<xref:uamqp.Message>,
<xref:LegacyMessage>

message_id

المعرف لتعريف الرسالة. معرف الرسالة هو قيمة مُعرَّفة من قِبل التطبيق، تُعرِّف الرسالة وحمولتها بشكل فريد. المُعرّف عبارة عن سلسلة ذات شكل حر، ويمكن أن تعكس GUID أو معرفاً مشتقاً من سياق التطبيق. إذا تم تمكينها، فإن ميزة الكشف عن التكرارات تحدد وتزيل عمليات الإرسال الثانية والاضافية للرسائل بنفس معرف الرسالة. :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

بيانات التعريف التي تم تعيينها بواسطة خدمة مراكز الأحداث المقترنة بالحدث.

يمكن أن تحتوي EventData على بعض بيانات التعريف التالية أو كلها اعتمادا على مصدر بيانات الحدث.

  • b"x-opt-sequence-number" (int)

  • b"x-opt-offset" (بايت)

  • ب"x-opt-partition-key" (بايت)

  • b"x-opt-enqueued-time" (int)

  • b"message-id" (بايت)

  • b"user-id" (بايت)

  • b"to" (بايت)

  • ب"الموضوع" (بايت)

  • ب"الرد على" (بايت)

  • b"correlation-id" (بايت)

  • b"content-type" (بايت)

  • ب"ترميز المحتوى" (بايت)

  • ب"وقت انتهاء الصلاحية المطلق" (int)

  • ب"وقت الإنشاء" (int)

  • b"group-id" (بايت)

  • b"group-sequence" (بايت)

  • b"reply-to-group-id" (بايت)

المرتجعات

النوع الوصف
dict[bytes, any]