QueueMessage Class

Queue message class.

Inheritance
builtins.object
QueueMessage

Constructor

QueueMessage()

Variables

Name Description
id
str

A GUID value assigned to the message by the Queue service that identifies the message in the queue. This value may be used together with the value of pop_receipt to delete a message from the queue after it has been retrieved with the get messages operation.

insertion_time
<xref:date>

A UTC date value representing the time the messages was inserted.

expiration_time
<xref:date>

A UTC date value representing the time the message expires.

dequeue_count
int

Begins with a value of 1 the first time the message is dequeued. This value is incremented each time the message is subsequently dequeued.

content
<xref:obj>

The message content. Type is determined by the decode_function set on the service. Default is str.

pop_receipt
str

A receipt str which can be used together with the message_id element to delete a message from the queue after it has been retrieved with the get messages operation. Only returned by get messages operations. Set to None for peek messages.

time_next_visible
<xref:date>

A UTC date value representing the time the message will next be visible. Only returned by get messages operations. Set to None for peek messages.