azure.servicebus.amqp package¶
- class azure.servicebus.amqp.AmqpAnnotatedMessage(*, header: AmqpMessageHeader | Mapping[str, Any] | None = None, footer: Dict[str, Any] | None = None, properties: AmqpMessageProperties | Mapping[str, Any] | None = None, application_properties: Dict[str, Any] | None = None, annotations: Dict[str, Any] | None = None, delivery_annotations: Dict[str, Any] | None = None, **kwargs: Any)[source]¶
The AMQP Annotated Message for advanced sending and receiving scenarios which allows you to access to low-level AMQP message sections. There should be one and only one of either data_body, sequence_body or value_body being set as the body of the AmqpAnnotatedMessage; if more than one body is set, ValueError will be raised. Please refer to the AMQP spec: http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#section-message-format for more information on the message format.
- Keyword Arguments:
data_body (str or bytes or list[str or bytes]) – The body consists of one or more data sections and each section contains opaque binary data.
sequence_body (list[any]) – The body consists of one or more sequence sections and each section contains an arbitrary number of structured data elements.
value_body (any) – The body consists of one amqp-value section and the section contains a single AMQP value.
header (AmqpMessageHeader or mapping[str, any] or None) – The amqp message header.
footer (dict or None) – The amqp message footer.
properties (AmqpMessageProperties or mapping[str, any] or None) – Properties to add to the amqp message.
application_properties (dict or None) – Service specific application properties.
annotations (dict or None) – Service specific message annotations.
delivery_annotations (dict or None) – Service specific delivery annotations.
- property annotations: Dict[str | bytes, Any] | None¶
Service specific message annotations.
- Return type:
Optional[Dict]
- property application_properties: Dict[str | bytes, Any] | None¶
Service specific application properties.
- Return type:
Optional[Dict]
- property body: Any¶
The body of the Message. The format may vary depending on the body type: For ~azure.servicebus.AmqpMessageBodyType.DATA, the body could be bytes or Iterable[bytes] For ~azure.servicebus.AmqpMessageBodyType.SEQUENCE, the body could be List or Iterable[List] For ~azure.servicebus.AmqpMessageBodyType.VALUE, the body could be any type. :rtype: Any
- property body_type: AmqpMessageBodyType¶
The body type of the underlying AMQP message. rtype: ~azure.servicebus.amqp.AmqpMessageBodyType
- property delivery_annotations: Dict[str | bytes, Any] | None¶
Delivery-specific non-standard properties at the head of the message. Delivery annotations convey information from the sending peer to the receiving peer.
- Return type:
Dict
The message footer.
- Return type:
Optional[Dict]
- property header: AmqpMessageHeader | None¶
The message header. :rtype: Optional[~azure.servicebus.amqp.AmqpMessageHeader]
- property properties: AmqpMessageProperties | None¶
Properties to add to the message. :rtype: Optional[~azure.servicebus.amqp.AmqpMessageProperties]
- class azure.servicebus.amqp.AmqpMessageBodyType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
- capitalize()¶
Return a capitalized version of the string.
More specifically, make the first character have upper case and the rest lower case.
- casefold()¶
Return a version of the string suitable for caseless comparisons.
- center(width, fillchar=' ', /)¶
Return a centered string of length width.
Padding is done using the specified fill character (default is a space).
- count(sub[, start[, end]]) int¶
Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.
- encode(encoding='utf-8', errors='strict')¶
Encode the string using the codec registered for encoding.
- encoding
The encoding in which to encode the string.
- errors
The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.
- endswith(suffix[, start[, end]]) bool¶
Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.
- expandtabs(tabsize=8)¶
Return a copy where all tab characters are expanded using spaces.
If tabsize is not given, a tab size of 8 characters is assumed.
- find(sub[, start[, end]]) int¶
Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.
Return -1 on failure.
- format(*args, **kwargs) str¶
Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).
- format_map(mapping) str¶
Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).
- index(sub[, start[, end]]) int¶
Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.
Raises ValueError when the substring is not found.
- isalnum()¶
Return True if the string is an alpha-numeric string, False otherwise.
A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.
- isalpha()¶
Return True if the string is an alphabetic string, False otherwise.
A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.
- isascii()¶
Return True if all characters in the string are ASCII, False otherwise.
ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.
- isdecimal()¶
Return True if the string is a decimal string, False otherwise.
A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.
- isdigit()¶
Return True if the string is a digit string, False otherwise.
A string is a digit string if all characters in the string are digits and there is at least one character in the string.
- isidentifier()¶
Return True if the string is a valid Python identifier, False otherwise.
Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.
- islower()¶
Return True if the string is a lowercase string, False otherwise.
A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.
- isnumeric()¶
Return True if the string is a numeric string, False otherwise.
A string is numeric if all characters in the string are numeric and there is at least one character in the string.
- isprintable()¶
Return True if the string is printable, False otherwise.
A string is printable if all of its characters are considered printable in repr() or if it is empty.
- isspace()¶
Return True if the string is a whitespace string, False otherwise.
A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.
- istitle()¶
Return True if the string is a title-cased string, False otherwise.
In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.
- isupper()¶
Return True if the string is an uppercase string, False otherwise.
A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.
- join(iterable, /)¶
Concatenate any number of strings.
The string whose method is called is inserted in between each given string. The result is returned as a new string.
Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’
- ljust(width, fillchar=' ', /)¶
Return a left-justified string of length width.
Padding is done using the specified fill character (default is a space).
- lower()¶
Return a copy of the string converted to lowercase.
- lstrip(chars=None, /)¶
Return a copy of the string with leading whitespace removed.
If chars is given and not None, remove characters in chars instead.
- static maketrans()¶
Return a translation table usable for str.translate().
If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.
- partition(sep, /)¶
Partition the string into three parts using the given separator.
This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.
If the separator is not found, returns a 3-tuple containing the original string and two empty strings.
- removeprefix(prefix, /)¶
Return a str with the given prefix string removed if present.
If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.
- removesuffix(suffix, /)¶
Return a str with the given suffix string removed if present.
If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.
- replace(old, new, count=-1, /)¶
Return a copy with all occurrences of substring old replaced by new.
- count
Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.
If the optional argument count is given, only the first count occurrences are replaced.
- rfind(sub[, start[, end]]) int¶
Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.
Return -1 on failure.
- rindex(sub[, start[, end]]) int¶
Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.
Raises ValueError when the substring is not found.
- rjust(width, fillchar=' ', /)¶
Return a right-justified string of length width.
Padding is done using the specified fill character (default is a space).
- rpartition(sep, /)¶
Partition the string into three parts using the given separator.
This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.
If the separator is not found, returns a 3-tuple containing two empty strings and the original string.
- rsplit(sep=None, maxsplit=-1)¶
Return a list of the substrings in the string, using sep as the separator string.
- sep
The separator used to split the string.
When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.
- maxsplit
Maximum number of splits. -1 (the default value) means no limit.
Splitting starts at the end of the string and works to the front.
- rstrip(chars=None, /)¶
Return a copy of the string with trailing whitespace removed.
If chars is given and not None, remove characters in chars instead.
- split(sep=None, maxsplit=-1)¶
Return a list of the substrings in the string, using sep as the separator string.
- sep
The separator used to split the string.
When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.
- maxsplit
Maximum number of splits. -1 (the default value) means no limit.
Splitting starts at the front of the string and works to the end.
Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.
- splitlines(keepends=False)¶
Return a list of the lines in the string, breaking at line boundaries.
Line breaks are not included in the resulting list unless keepends is given and true.
- startswith(prefix[, start[, end]]) bool¶
Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.
- strip(chars=None, /)¶
Return a copy of the string with leading and trailing whitespace removed.
If chars is given and not None, remove characters in chars instead.
- swapcase()¶
Convert uppercase characters to lowercase and lowercase characters to uppercase.
- title()¶
Return a version of the string where each word is titlecased.
More specifically, words start with uppercased characters and all remaining cased characters have lower case.
- translate(table, /)¶
Replace each character in the string using the given translation table.
- table
Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.
The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.
- upper()¶
Return a copy of the string converted to uppercase.
- zfill(width, /)¶
Pad a numeric string with zeros on the left, to fill a field of the given width.
The string is never truncated.
- DATA = 'data'¶
- SEQUENCE = 'sequence'¶
- VALUE = 'value'¶
- class azure.servicebus.amqp.AmqpMessageHeader(*, delivery_count: int | None = None, time_to_live: int | None = None, durable: bool | None = None, first_acquirer: bool | None = None, priority: int | None = None, **kwargs: Any)[source]¶
The Message header. The Message header. This is only used on received message, and not set on messages being sent. The properties set on any given message will depend on the Service and not all messages will have all properties. Please refer to the AMQP spec: http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#type-header for more information on the message header.
- Keyword Arguments:
delivery_count (Optional[int]) – The number of unsuccessful previous attempts to deliver this message. If this value is non-zero it can be taken as an indication that the delivery might be a duplicate. On first delivery, the value is zero. It is incremented upon an outcome being settled at the sender, according to rules defined for each outcome.
time_to_live (Optional[int]) – Duration in milliseconds for which the message is to be considered “live”. If this is set then a message expiration time will be computed based on the time of arrival at an intermediary. Messages that live longer than their expiration time will be discarded (or dead lettered). When a message is transmitted by an intermediary that was received with a ttl, the transmitted message’s header SHOULD contain a ttl that is computed as the difference between the current time and the formerly computed message expiration time, i.e., the reduced ttl, so that messages will eventually die if they end up in a delivery loop.
durable (Optional[bool]) – Durable messages MUST NOT be lost even if an intermediary is unexpectedly terminated and restarted. A target which is not capable of fulfilling this guarantee MUST NOT accept messages where the durable header is set to True: if the source allows the rejected outcome then the message SHOULD be rejected with the precondition-failed error, otherwise the link MUST be detached by the receiver with the same error.
first_acquirer (Optional[bool]) – If this value is True, then this message has not been acquired by any other link. If this value is False, then this message MAY have previously been acquired by another link or links.
priority (Optional[int]) – This field contains the relative message priority. Higher numbers indicate higher priority messages. Messages with higher priorities MAY be delivered before those with lower priorities.
- Variables:
delivery_count (Optional[int]) – The number of unsuccessful previous attempts to deliver this message. If this value is non-zero it can be taken as an indication that the delivery might be a duplicate. On first delivery, the value is zero. It is incremented upon an outcome being settled at the sender, according to rules defined for each outcome.
time_to_live (Optional[int]) – Duration in milliseconds for which the message is to be considered “live”. If this is set then a message expiration time will be computed based on the time of arrival at an intermediary. Messages that live longer than their expiration time will be discarded (or dead lettered). When a message is transmitted by an intermediary that was received with a ttl, the transmitted message’s header SHOULD contain a ttl that is computed as the difference between the current time and the formerly computed message expiration time, i.e., the reduced ttl, so that messages will eventually die if they end up in a delivery loop.
durable (Optional[bool]) – Durable messages MUST NOT be lost even if an intermediary is unexpectedly terminated and restarted. A target which is not capable of fulfilling this guarantee MUST NOT accept messages where the durable header is set to True: if the source allows the rejected outcome then the message SHOULD be rejected with the precondition-failed error, otherwise the link MUST be detached by the receiver with the same error.
first_acquirer (Optional[bool]) – If this value is True, then this message has not been acquired by any other link. If this value is False, then this message MAY have previously been acquired by another link or links.
priority (Optional[int]) – This field contains the relative message priority. Higher numbers indicate higher priority messages. Messages with higher priorities MAY be delivered before those with lower priorities.
- class azure.servicebus.amqp.AmqpMessageProperties(*, message_id: str | bytes | 'uuid.UUID' | None = None, user_id: str | bytes | None = None, to: str | bytes | None = None, subject: str | bytes | None = None, reply_to: str | bytes | None = None, correlation_id: str | bytes | None = None, content_type: str | bytes | None = None, content_encoding: str | bytes | None = None, creation_time: int | None = None, absolute_expiry_time: int | None = None, group_id: str | bytes | None = None, group_sequence: int | None = None, reply_to_group_id: str | bytes | None = None, **kwargs: Any)[source]¶
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. Please refer to the AMQP spec: http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#type-properties for more information on the message properties.
- Keyword Arguments:
message_id (Optional[Union[str, bytes, uuid.UUID]]) – Message-id, if set, uniquely identifies a message within the message system. The message sender 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 (Optional[Union[str, bytes]]) – The identity of the user responsible for producing the message. The client sets this value, and it MAY be authenticated by intermediaries.
to (Optional[Union[str, 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 (Optional[Union[str, bytes]]) – A common field for summary information about the message content and purpose.
reply_to (Optional[Union[str, bytes]]) – The address of the node to send replies to.
correlation_id (Optional[Union[str, bytes]]) – This is a client-specific id that can be used to mark or identify messages between clients.
content_type (Optional[Union[str, bytes]]) – The RFC-2046 MIME type for the message’s application-data section (body).
content_encoding (Optional[Union[str, bytes]]) – The content-encoding property is used as a modifier to the content-type.
creation_time (Optional[int]) – An absolute time when this message was created.
absolute_expiry_time (Optional[int]) – An absolute time when this message is considered to be expired.
group_id (Optional[Union[str, bytes]]) – Identifies the group the message belongs to.
group_sequence (Optional[int]) – The relative position of this message within its group.
reply_to_group_id (Optional[Union[str, bytes]]) – This is a client-specific id that is used so that client can send replies to this message to a specific group.
- Variables:
message_id (Optional[Union[str, bytes, uuid.UUID]]) – Message-id, if set, uniquely identifies a message within the message system. The message sender 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 (Optional[Union[str, bytes]]) – The identity of the user responsible for producing the message. The client sets this value, and it MAY be authenticated by intermediaries.
to (Optional[Union[str, 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 (Optional[Union[str, bytes]]) – A common field for summary information about the message content and purpose.
reply_to (Optional[Union[str, bytes]]) – The address of the node to send replies to.
correlation_id (Optional[Union[str, bytes]]) – his is a client-specific id that can be used to mark or identify messages between clients.
content_type (Optional[Union[str, bytes]]) – The RFC-2046 MIME type for the message’s application-data section (body).
content_encoding (Optional[Union[str, bytes]]) – The content-encoding property is used as a modifier to the content-type.
creation_time (Optional[int]) – An absolute time when this message was created.
absolute_expiry_time (Optional[int]) – An absolute time when this message is considered to be expired.
group_id (Optional[Union[str, bytes]]) – Identifies the group the message belongs to.
group_sequence (Optional[int]) – The relative position of this message within its group.
reply_to_group_id (Optional[Union[str, bytes]]) – This is a client-specific id that is used so that client can send replies to this message to a specific group.