Skip to content

[EH] Docstring #38122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 31, 2024
Merged

[EH] Docstring #38122

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions sdk/eventhub/azure-eventhub/azure/eventhub/amqp/_amqp_message.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,10 +170,13 @@ def _from_amqp_message(self, message):

@property
def body(self) -> Any:
"""The body of the Message. The format may vary depending on the body type:
For ~azure.eventhub.AmqpMessageBodyType.DATA, the body could be bytes or Iterable[bytes]
For ~azure.eventhub.AmqpMessageBodyType.SEQUENCE, the body could be List or Iterable[List]
For ~azure.eventhub.AmqpMessageBodyType.VALUE, the body could be any type.
"""
The body of the Message. The format may vary depending on the body type:

For AmqpMessageBodyType.DATA, the body could be bytes or Iterable[bytes].
For AmqpMessageBodyType.SEQUENCE, the body could be List or Iterable[List].
For AmqpMessageBodyType.VALUE, the body could be any type.

:rtype: Any
"""
if self._body_type == AmqpMessageBodyType.DATA: # pylint:disable=no-else-return
Expand All @@ -186,15 +189,18 @@ def body(self) -> Any:

@property
def body_type(self) -> AmqpMessageBodyType:
"""The body type of the underlying AMQP message.
rtype: ~azure.eventhub.amqp.AmqpMessageBodyType
"""
The body type of the underlying AMQP message.

:rtype: ~azure.eventhub.amqp.AmqpMessageBodyType
"""
return self._body_type

@property
def properties(self) -> Optional[AmqpMessageProperties]:
"""
Properties to add to the message.

:rtype: Optional[~azure.eventhub.amqp.AmqpMessageProperties]
"""
return self._properties
Expand Down Expand Up @@ -247,6 +253,7 @@ def delivery_annotations(self, value: Optional[Dict[Union[str, bytes], Any]]) ->
def header(self) -> Optional[AmqpMessageHeader]:
"""
The message header.

:rtype: Optional[~azure.eventhub.amqp.AmqpMessageHeader]
"""
return self._header
Expand Down