-
Notifications
You must be signed in to change notification settings - Fork 3.2k
[ServiceBus] Docstring and Changelog adjustment #11166
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.
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
Changes from 31 commits
cb13bd8
38e9f65
aa30bc0
c4710ea
053f073
f0697f7
c83241a
18c6fba
607f134
88fd7d1
fcbaf65
f52e2d9
8aaaf1e
a12351c
cc9dbb9
932336a
2742ca0
72ab463
213bb9d
b312d19
0638b9a
c7bd430
de47f42
2fcc005
cfa9d81
ac224c1
1305495
2183d32
e233d8c
660e518
dca752b
b2c7f45
55174c0
a6c9480
20e87ad
48dabf7
563b63b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,9 +10,12 @@ | |
| - Use `ServiceBusSender.schedule(messages, schedule_time_utc)` for scheduling messages. | ||
| - Use `ServiceBusSender.cancel_scheduled_messages(sequence_numbers)` for scheduled messages cancellation. | ||
| * `ServiceBusSender.send()` can now send a list of messages in one call, if they fit into a single batch. If they do not fit a `ValueError` is thrown. | ||
| * `BatchMessage.add()` and `ServiceBusSender.send()` raises `MessageContentTooLarge`, which is a subclass of `ValueError` if the content is over-sized. | ||
| * `ServiceBusReceiver.receive()` raises `ValueError` if the max_batch_size is greater than the prefetch of `ServiceBusClient`. | ||
| * `BatchMessage.add()` and `ServiceBusSender.send()` would raise `MessageContentTooLarge` if the content is over-sized. | ||
| * `ServiceBusReceiver.receive()` raises `ValueError` if its param `max_batch_size` is greater than param `prefetch` of `ServiceBusClient`. | ||
| * Added exception classes `MessageError`, `MessageContentTooLarge`, `ServiceBusAuthenticationError`. | ||
| - `MessageError`: when you try to send a problematic message. | ||
|
||
| - `MessageContentTooLarge`: when you send an over-sized message. A subclass of `ValueError` and `MessageError`. | ||
| - `ServiceBusAuthenticationError`: fail to be authenticated by the service. | ||
KieranBrantnerMagee marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| * Removed exception class `InvalidHandlerState`. | ||
|
|
||
| **BugFixes** | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -301,10 +301,12 @@ def send(self, message): | |
| :param message: The ServiceBus message to be sent. | ||
| :type message: ~azure.servicebus.Message or ~azure.servicebus.BatchMessage or list[~azure.servicebus.Message] | ||
| :rtype: None | ||
| :raises: :class: ~azure.servicebus.exceptions.MessageSendFailed if the message fails to | ||
| send | ||
| :raises: | ||
| :class: ~azure.servicebus.exceptions.OperationTimeoutError if sending times out. | ||
| :class: `ValueError` if list of messages is provided and cannot fit in a batch. | ||
| :class: ~azure.servicebus.exceptions.MessageContentTooLarge if the size of the message is over | ||
| service bus frame size limit. | ||
| :class: ~azure.servicebus.exceptions.MessageSendFailed if the message fails to send | ||
| :class: ~azure.servicebus.exceptions.ServiceBusError. The parent class of above errors. | ||
|
||
|
|
||
| .. admonition:: Example: | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.