Share via

ServiceBusMessage Class

  • Reference

An HTTP response object.

Constructor

ServiceBusMessage(*, body: bytes, trigger_metadata: Mapping[str, Any] | None = None, application_properties: Dict[str, Any], content_type: str | None = None, correlation_id: str | None = None, dead_letter_error_description: str | None = None, dead_letter_reason: str | None = None, dead_letter_source: str | None = None, delivery_count: int | None = None, enqueued_sequence_number: int | None = None, enqueued_time_utc: datetime | None = None, expires_at_utc: datetime | None = None, label: str | None = None, locked_until: datetime | None = None, lock_token: str | None = None, message_id: str, partition_key: str | None = None, reply_to: str | None = None, reply_to_session_id: str | None = None, scheduled_enqueue_time_utc: datetime | None = None, sequence_number: int | None = None, session_id: str | None = None, state: int | None = None, subject: str | None = None, time_to_live: timedelta | None = None, to: str | None = None, transaction_partition_key: str | None = None, user_properties: Dict[str, object])

Keyword-Only Parameters

Name Description
body
Required
trigger_metadata
Default value: None
application_properties
Required
content_type
Default value: None
correlation_id
Default value: None
dead_letter_error_description
Default value: None
dead_letter_reason
Default value: None
dead_letter_source
Default value: None
delivery_count
Default value: None
enqueued_sequence_number
Default value: None
enqueued_time_utc
Default value: None
expires_at_utc
Default value: None
label
Default value: None
locked_until
Default value: None
lock_token
Default value: None
message_id
Required
partition_key
Default value: None
reply_to
Default value: None
reply_to_session_id
Default value: None
scheduled_enqueue_time_utc
Default value: None
sequence_number
Default value: None
session_id
Default value: None
state
Default value: None
subject
Default value: None
time_to_live
Default value: None
to
Default value: None
transaction_partition_key
Default value: None
user_properties
Required

Methods

get_body

get_body 

get_body() -> bytes

Attributes

application_properties

content_type

correlation_id

dead_letter_error_description

dead_letter_reason

dead_letter_source

delivery_count

enqueued_sequence_number

enqueued_time_utc

expiration_time

(Deprecated) Use expires_at_utc instead

expires_at_utc

force_persistence

label

lock_token

locked_until

message_id

metadata

partition_key

reply_to

reply_to_session_id

scheduled_enqueue_time

(Deprecated) Use scheduled_enqueue_time_utc instead

scheduled_enqueue_time_utc

sequence_number

session_id

state

subject

time_to_live

to

transaction_partition_key

user_properties