Skip to content
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

[Service Bus] API review changes to the Batch object and its related methods #14639

Closed
ramya-rao-a opened this issue Oct 20, 2020 · 2 comments · Fixed by #14751
Closed

[Service Bus] API review changes to the Batch object and its related methods #14639

ramya-rao-a opened this issue Oct 20, 2020 · 2 comments · Fixed by #14751
Assignees
Labels
blocking-release Blocks release Client This issue points to a problem in the data-plane of the library. Service Bus

Comments

@ramya-rao-a
Copy link
Contributor

ramya-rao-a commented Oct 20, 2020

Findings for the Batch object and its related methods from internal API review for version 7.0.0-b7 of the Azure Service Bus package:

  • Rename BatchMessage to MessageBatch. Consider adding ServiceBus prefix after discussing with the Python team
    - If we are adding the ServiceBus prefix, also consider doing so for Message
  • max_size_in_bytes on the batch object should be readonly. Log an issue to add this in Event Hubs as well
  • message on the batch object need not be public.
  • Consider renaming create_batch() method to create_message_batch(). We use the "message"/"messages" term in all other methods on the sender and receiver, so this should sit right well.
  • Similarly, consider renaming add() method on the batch to addMessage() to resolve the confusion we saw in certain user studies where it was not clear what the next step was after creating a batch
@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Oct 20, 2020
@ramya-rao-a ramya-rao-a added blocking-release Blocks release Client This issue points to a problem in the data-plane of the library. Service Bus labels Oct 20, 2020
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Oct 20, 2020
@ramya-rao-a ramya-rao-a added this to the [2020] November milestone Oct 20, 2020
@ramya-rao-a
Copy link
Contributor Author

@annatisch Can you provide some help to the points above that we are "considering"?

@annatisch
Copy link
Member

Thanks @ramya-rao-a - I'm good with these changes :)

@yunhaoling yunhaoling linked a pull request Oct 26, 2020 that will close this issue
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
blocking-release Blocks release Client This issue points to a problem in the data-plane of the library. Service Bus
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants