Fix Javadoc errors in client/sniffer

[gzurowski]

Description

Fix Javadoc comments to fix Javadoc errors as described in issue #221.

Issues Resolved

Fixes Javadoc errors in the client/rest module.

Verified by running ./gradlew :client:sniffer:missingJavadoc.

Check List

• New functionality includes testing.
  • All tests pass
• New functionality has been documented.
  • New functionality has javadoc added
• Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[opensearch-ci-bot]

✅   Gradle Wrapper Validation success 50a9252

[opensearch-ci-bot]

✅   DCO Check Passed 50a9252

[opensearch-ci-bot]

❌   Gradle Precommit failure 50a9252
Log 401

[nknize]

LGTM. Thank you for taking care of these javadocs!

[nknize]

start gradle precommit

[nknize]

@peterzhuamazon can we force trigger a precommit? The failure looks unrelated to the PR.

[opensearch-ci-bot]

❌   Gradle Precommit failure 50a9252
Log 403

[setiah]

@peterzhuamazon can we force trigger a precommit? The failure looks unrelated to the PR.

The precommit fails because of an independent issue, #449 . Hopefully #707 should fix this.

[setiah]

Hey @gzurowski thanks for your PR. javadoc branch is old and needs to be deprecated. I have opened PR #715 to merge all javadoc feature branch changes to main after fixing a few issues. Would you mind rebasing this PR on main, once #715 is merged?

[gzurowski]

Hey @gzurowski thanks for your PR. javadoc branch is old and needs to be deprecated. I have opened PR #715 to merge all javadoc feature branch changes to main after fixing a few issues. Would you mind rebasing this PR on main, once #715 is merged?

Sure, I will rebase it as soon at #715 is merged.

[setiah]

Hey @gzurowski thanks for your PR. javadoc branch is old and needs to be deprecated. I have opened PR #715 to merge all javadoc feature branch changes to main after fixing a few issues. Would you mind rebasing this PR on main, once #715 is merged?

Sure, I will rebase it as soon at #715 is merged.

Thanks @gzurowski . I have merged #715 , you may now proceed. This PR got closed due to deletion of javadoc branch.