EventData 클래스

  • 참조

EventData 클래스는 이벤트 콘텐츠에 대한 컨테이너입니다.

상속
builtins.object
EventData

생성자

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

매개 변수

Name 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]

매개 변수

Name Description
encoding
str

이벤트 데이터를 디코딩하는 데 사용할 인코딩입니다. 기본값은 'UTF-8'입니다.

기본값: UTF-8

반환

형식 Description
dict[str, any]

JSON 개체입니다.

body_as_str

데이터가 호환되는 형식인 경우 이벤트의 내용을 문자열로 지정합니다.

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

매개 변수

Name Description
encoding
str

이벤트 데이터를 디코딩하는 데 사용할 인코딩입니다. 기본값은 'UTF-8'입니다.

기본값: UTF-8

반환

형식 Description
str

이벤트의 내용을 문자열로 지정합니다.

from_message_content

콘텐츠 형식과 본문으로 설정할 콘텐츠 값이 지정된 EventData 개체를 만듭니다.

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

매개 변수

Name Description
content
필수
bytes

메시지 본문으로 설정할 콘텐츠 값입니다.
content_type
필수
str

메시지에 설정할 콘텐츠 형식입니다.

반환

형식 Description
EventData

EventData 개체입니다.

특성

body

메시지의 본문입니다. 형식은 본문 유형에 따라 다를 수 있습니다. 의 경우 DATA본문은 바이트 또는 반복 가능[바이트]일 수 있습니다. 의 경우 SEQUENCE본문은 List 또는 Iterable[List]일 수 있습니다. 의 경우 VALUE본문은 모든 형식일 수 있습니다.

반환

형식 Description
int,
bool,
float,
bytes,
str,
dict,
list,
UUID

body_type

기본 AMQP 메시지의 본문 유형입니다.

반환

형식 Description
AmqpMessageBodyType

content_type

콘텐츠 형식 설명자입니다. 필요에 따라 "application/json"과 같은 RFC2045 섹션 5 형식을 따르는 설명자를 사용하여 메시지의 페이로드를 설명합니다. :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

메시지를 식별할 ID입니다. 메시지 식별자는 메시지 및 해당 페이로드를 고유하게 식별하는 애플리케이션 정의 값입니다. 식별자는 자유 형식 문자열이고 애플리케이션 컨텍스트에서 파생된 GUID 또는 식별자를 반영할 수 있습니다. 사용하도록 설정된 경우 중복 검색 기능은 메시지 ID가 동일한 메시지의 두 번째 및 추가 제출을 식별하고 제거합니다. :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

이벤트와 연결된 Event Hubs 서비스에서 설정한 메타데이터입니다.

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]