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

Adding documentation for EventData properties #31175

Merged
merged 2 commits into from
Sep 29, 2022

Conversation

conniey
Copy link
Member

@conniey conniey commented Sep 27, 2022

Description

Adds documentation as to what objects can be put in EventData.getProperties

Fixes #31095

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@conniey conniey self-assigned this Sep 27, 2022
@ghost ghost added the Event Hubs label Sep 27, 2022
@azure-sdk
Copy link
Collaborator

API change check

API changes are not detected in this pull request.

@conniey conniey merged commit 74617c7 into Azure:main Sep 29, 2022
@conniey conniey deleted the documentation-issue branch September 29, 2022 18:30
@bvahdat
Copy link

bvahdat commented Sep 30, 2022

Thanks @conniey for this adjustment. I am wondering if the provided listing is complete, see:

https://github.com/apache/qpid-proton-j/tree/main/proton-j/src/main/java/org/apache/qpid/proton/codec

What about:

  • Array
  • ByteBuffer
  • List
  • Long
  • Map
  • Void
  • Timestamp

Shouldn't we also add all the corresponding Java primitive types as well?

I also wonder if we should list all the supported Qpid Proton's own custom types:

https://github.com/apache/qpid-proton-j/tree/main/proton-j/src/main/java/org/apache/qpid/proton/amqp

Such as Binary, Symbol, UnsignedShort etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

EventHubs EventData.getProperties() documentation
4 participants