MessageProperties Class

Message properties. The properties that are actually used will depend on the service implementation. Not all received messages will have all properties, and not all properties will be utilized on a sent message.

Inheritance

builtins.object

MessageProperties

Constructor

MessageProperties(message_id=None, user_id=None, to=None, subject=None, reply_to=None, correlation_id=None, content_type=None, content_encoding=None, absolute_expiry_time=None, creation_time=None, group_id=None, group_sequence=None, reply_to_group_id=None, properties=None, encoding='UTF-8')

Parameters

Name	Description
message_id	Default value: None
user_id	Default value: None
to	Default value: None
subject	Default value: None
reply_to	Default value: None
correlation_id	Default value: None
content_type	Default value: None
content_encoding	Default value: None
absolute_expiry_time	Default value: None
creation_time	Default value: None
group_id	Default value: None
group_sequence	Default value: None
reply_to_group_id	Default value: None
properties	Default value: None
encoding	Default value: UTF-8

Variables

Name	Description
message_id	str or bytes or UUID or AMQPType Message-id, if set, uniquely identifies a message within the message system. The message producer is usually responsible for setting the message-id in such a way that it is assured to be globally unique. A broker MAY discard a message as a duplicate if the value of the message-id matches that of a previously received message sent to the same node.
user_id	str or bytes The identity of the user responsible for producing the message. The client sets this value, and it MAY be authenticated by intermediaries.
to	str or bytes The to field identifies the node that is the intended destination of the message. On any given transfer this might not be the node at the receiving end of the link.
subject
reply_to
correlation_id
content_type
content_encoding
absolute_expiry_time
creation_time
group_id
group_sequence
reply_to_group_id

Methods

get_properties_obj

Get the underlying C reference from this object.

get_properties_obj

Get the underlying C reference from this object.

get_properties_obj()

Returns

Type	Description
cProperties

Attributes

absolute_expiry_time

content_encoding

content_type

correlation_id

creation_time

group_id

group_sequence

message_id

reply_to

reply_to_group_id

subject

to

user_id