Aracılığıyla paylaş

EventData Sınıf

  • Başvuru

EventData sınıfı, olay içeriği için bir kapsayıcıdır.

Devralma
builtins.object
EventData

Oluşturucu

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

Parametreler

Name Description
body
str veya bytes

Tek bir iletide gönderilecek veriler. gövde, str veya bayt türünde olabilir.

varsayılan değer: None

Örnekler

EventData örnekleri oluşturma


       from azure.eventhub import EventData

       event_data = EventData("String data")
       event_data = EventData(b"Bytes data")

Yöntemler

body_as_json

Veriler uyumluysa, JSON nesnesi olarak yüklenen olayın içeriği.
body_as_str

Veriler uyumlu bir türdeyse, olayın içeriği dize olarak.
from_message_content

Verilen içerik türüne sahip bir EventData nesnesi ve gövde olarak ayarlanacak bir içerik değeri oluşturur.

body_as_json

Veriler uyumluysa, JSON nesnesi olarak yüklenen olayın içeriği.

body_as_json(encoding: str = 'UTF-8') -> Dict[str, Any]

Parametreler

Name Description
encoding
str

Olay verilerinin kodunu çözmek için kullanılacak kodlama. Varsayılan değer : 'UTF-8'

varsayılan değer: UTF-8

Döndürülenler

Tür Description
dict[str, any]

JSON nesnesi.

body_as_str

Veriler uyumlu bir türdeyse, olayın içeriği dize olarak.

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

Parametreler

Name Description
encoding
str

Olay verilerinin kodunu çözmek için kullanılacak kodlama. Varsayılan değer : 'UTF-8'

varsayılan değer: UTF-8

Döndürülenler

Tür Description
str

Olayın içeriği bir dize olarak.

from_message_content

Verilen içerik türüne sahip bir EventData nesnesi ve gövde olarak ayarlanacak bir içerik değeri oluşturur.

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

Parametreler

Name Description
content
Gerekli
bytes

İletinin gövdesi olarak ayarlanacak içerik değeri.
content_type
Gerekli
str

İletide ayarlanacak içerik türü.

Döndürülenler

Tür Description
EventData

EventData nesnesi.

Öznitelikler

body

İletinin gövdesi. Biçim, gövde türüne bağlı olarak değişebilir: için DATAgövde bayt veya Yinelenebilir[bayt] olabilir. için SEQUENCEgövde List veya Iterable[List] olabilir. için VALUEgövde herhangi bir türde olabilir.

Döndürülenler

Tür Description
int,
bool,
float,
bytes,
str,
dict,
list,
UUID

body_type

Temel alınan AMQP iletisinin gövde türü.

Döndürülenler

Tür Description
AmqpMessageBodyType

content_type

İçerik türü tanımlayıcısı. İsteğe bağlı olarak, RFC2045, Bölüm 5 biçimini izleyen bir tanımlayıcı ile iletinin yükünü açıklar, örneğin "application/json". :rtype: str veya None

correlation_id

Bağıntı tanımlayıcısı. Bir uygulamanın bağıntı amacıyla, örneğin yanıtlanan iletinin MessageId değerini yansıtan ileti için bir bağlam belirtmesine izin verir. :rtype: str veya None

enqueued_time

Olayın sıraya alınan zaman damgası.

Döndürülenler

Tür Description
datetime,
None

message

Temel uamqp'yi alın. İleti veya LegacyMessage. Bu kullanım dışıdır ve sonraki bir sürümde kaldırılacaktır.

Döndürülenler

Tür Description
<xref:uamqp.Message>,
<xref:LegacyMessage>

message_id

İletiyi tanımlamak için kimlik. İleti tanımlayıcısı, iletiyi ve yükünü benzersiz olarak tanımlayan uygulama tanımlı bir değerdir. Tanımlayıcı serbest biçimli bir dizedir ve bir GUID veya uygulama bağlamından türetilmiş bir tanımlayıcıyı yansıtabilir. Etkinleştirilirse, yinelenen algılama özelliği aynı ileti kimliğine sahip iletilerin ikinci ve daha fazla gönderimini tanımlar ve kaldırır. :rtype: str veya None

offset

Olayın uzaklığı.

Döndürülenler

Tür Description
str,
None

partition_key

Olayın bölüm anahtarı.

Döndürülenler

Tür Description
bytes,
None

properties

Olaydaki uygulama tanımlı özellikler.

Döndürülenler

Tür Description
dict[str, any],
dict[bytes, any]

raw_amqp_message

Yalnızca gelişmiş kullanım. Gönderilen veya alınan iç AMQP ileti yükü.

Döndürülenler

Tür Description
AmqpAnnotatedMessage

sequence_number

Olayın sıra numarası.

Döndürülenler

Tür Description
int,
None

system_properties

Olayla ilişkili Event Hubs Hizmeti tarafından ayarlanan meta veriler.

EventData, olay verilerinin kaynağına bağlı olarak aşağıdaki meta verilerin bir kısmına veya tümüne sahip olabilir.

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

  • b"x-opt-offset" (bayt)

  • b"x-opt-partition-key" (bayt)

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

  • b"message-id" (bayt)

  • b"user-id" (bayt)

  • b"to" (bayt)

  • b"subject" (bayt)

  • b"yanıtla" (bayt)

  • b"bağıntı-kimliği" (bayt)

  • b"content-type" (bayt)

  • b"content-encoding" (bayt)

  • b"mutlak-süre sonu-süresi" (int)

  • b"oluşturma zamanı" (int)

  • b"group-id" (bayt)

  • b"grup dizisi" (bayt)

  • b"reply-to-group-id" (bayt)

Döndürülenler

Tür Description
dict[bytes, any]