QueueMessage Class

  • Reference

Represents a queue message.

Inheritance
azure.storage.queue._shared.models.DictMixin
QueueMessage

Constructor

QueueMessage(content: Any | None = None, **kwargs: Any)

Parameters

Name Description
content
default value: None

Methods

get
has_key
items
keys
update
values

get 

get(key, default=None)

Parameters

Name Description
key
Required
default
default value: None

has_key 

has_key(k)

Parameters

Name Description
k
Required

items 

items()

keys 

keys()

update 

update(*args, **kwargs)

values 

values()

Attributes

content

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

content: Any

dequeue_count

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

dequeue_count: int | None

expires_on

A UTC date value representing the time the message expires.

expires_on: datetime | None

id

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 receive messages operation.

id: str

inserted_on

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

inserted_on: datetime | None

next_visible_on

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

next_visible_on: datetime | None

pop_receipt

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 receive messages operation. Only returned by receive messages operations. Set to None for peek messages.

pop_receipt: str | None