QueueMessage Class
A Queue message object.
Constructor
QueueMessage(*, id: str | None = None, body: str | bytes | None = None, pop_receipt: str | None = None)Parameters
| Name | Description |
|---|---|
|
id
Required
|
An optional string specifying the ID of the message. |
|
body
Required
|
A string or bytes instance specifying the message body. |
|
pop_receipt
Required
|
An optional string containing the pop receipt token. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
id
|
Default value: None
|
|
body
|
Default value: None
|
|
pop_receipt
|
Default value: None
|
Methods
| get_body |
Return message content as bytes. |
| get_json |
Decode and return message content as a JSON object. |
get_body
Return message content as bytes.
get_body() -> bytesget_json
Decode and return message content as a JSON object.
get_json() -> AnyReturns
| Type | Description |
|---|---|
|
Decoded JSON data. |
Exceptions
| Type | Description |
|---|---|
|
when the body of the message does not contain valid JSON data. |
Attributes
dequeue_count
The number of times this message has been dequeued.
expiration_time
A datetime object with the message expiry time.
id
Message ID.
insertion_time
A datetime object with the message queue insertion time.
pop_receipt
The message pop receipt token as a string.
time_next_visible
A datetime object with the time the message will be visible next.
