Fixing various javadocs

[ker2x]

Greetings !
I'm in the process of completing javadoc of OpenSearch.
I have other javadoc fix in progress but not yet ready.

I tried my best following the contributing rule. i hope it's ok.
I didn't create a new issue as there is this one already #221

Should i make one large pull request or many small one ?

Thank you,

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/24632/
• CommitID: 63af40e
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Compatibility status:

Checks if related components are compatible with change 157dd0c

Incompatible components

Incompatible components: [https://github.com/opensearch-project/security.git]

Skipped components

Compatible components

Compatible components: [https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/sql.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/security-analytics.git, https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/performance-analyzer.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/neural-search.git]

[kotwanikunal]

• https://build.ci.opensearch.org/job/gradle-check/24643/

#9191

[kotwanikunal]

I fixed the previous error (my bad) But this new failure doesn't appear to be related to my commit. (unless i'm misunderstanding the error) Any tips appreciated.

@ker2x Thanks for contributing :)
You are right - the error is unrelated to your change. It is a flaky test and I have linked the issue.
Restarting the workflows.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/24709/
• CommitID: c79edc8
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[kotwanikunal]

#9776

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/24709/
• CommitID: c79edc8
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/24730/
• CommitID: c79edc8
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/24744/
• CommitID: c79edc8
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/25020/
• CommitID: 0662ffd
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Compatibility status:

Checks if related components are compatible with change 0662ffd

Incompatible components

Skipped components

Compatible components

Compatible components: [https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/security.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/neural-search.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/security-analytics.git, https://github.com/opensearch-project/sql.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/performance-analyzer.git, https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/reporting.git]

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/25173/
• CommitID: 0662ffd
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/25200/
• CommitID: 0662ffd
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[ker2x]

i have much more javadoc to commit, should i wait ?

[msfroh]

i have much more javadoc to commit, should i wait ?

Let's merge this one first.

Gradle checks are failing due to flaky tests. I've restarted the check run (see https://github.com/opensearch-project/OpenSearch/actions/runs/6113402537/job/16644851983?pr=9817), but I suspect that you may need to merge from main again to pick up the fixes for those tests. Sorry about that :(

Thank you so much for these fixes, @ker2x! These new Javadocs are so much better.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/25241/
• CommitID: 0662ffd
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[ker2x]

Thank you so much for these fixes, @ker2x! These new Javadocs are so much better.

Merged. i didn't make the mistake to commit on my main this time so i didn't mistakenly push more unrefined javadoc this time :) Let's see how it goes.

there are some javadoc with some "todo fix before commit" in this PR. I'll fix it in next PR (i shouldn't have disabled the "check for TODO" in inteliJ ^^)

thanks for the kind words. i'm having fun doing this. (i'm an Elastic database administrator switching to opensearch. i'm doing this for learning purpose)

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/25243/
• CommitID: 157dd0c
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: UNSTABLE ❕
• TEST FAILURES:

      1 org.opensearch.smoketest.SmokeTestMultiNodeClientYamlTestSuiteIT.test {yaml=pit/10_basic/Delete all}

• URL: https://build.ci.opensearch.org/job/gradle-check/25245/
• CommitID: 157dd0c
  Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

[codecov]

Codecov Report

Merging #9817 (157dd0c) into main (c100c0c) will decrease coverage by 0.06%.
The diff coverage is 100.00%.

@@             Coverage Diff              @@
##               main    #9817      +/-   ##
============================================
- Coverage     71.16%   71.11%   -0.06%     
- Complexity    58114    58126      +12     
============================================
  Files          4824     4824              
  Lines        273897   273897              
  Branches      39910    39910              
============================================
- Hits         194926   194788     -138     
- Misses        62573    62800     +227     
+ Partials      16398    16309      -89     

Files Changed	Coverage Δ
...main/java/org/opensearch/common/collect/Tuple.java	64.70% <ø> (ø)
...java/org/opensearch/common/crypto/DataKeyPair.java	0.00% <ø> (ø)
...h/common/crypto/DecryptedRangedStreamProvider.java	0.00% <ø> (ø)
...g/opensearch/compress/spi/CompressionProvider.java	100.00% <ø> (ø)
...cli/src/main/java/org/opensearch/cli/Terminal.java	74.73% <100.00%> (ø)

... and 469 files with indirect coverage changes