[Segment Replication] Modify shrink exception to be more informative

[Poojita-Raj]

Description

For a call to shrink index in a segment replication enabled cluster, we perform a fast fail whenever the replica shards of the source index are not up to date with their primary shard. However, the exception we provide only asks customers/users to retry after sometime but does not specify how to check if their replicas are now up to date and ready for a retry of a shrink operation. Changed the exception to reflect this additional information.

Related Issues

Resolves #11352 partially.

Check List

• New functionality includes testing.
  • All tests pass
• New functionality has been documented.
  • New functionality has javadoc added
• Failing checks are inspected and point to the corresponding known issue(s) (See: Troubleshooting Failing Builds)
• Commits are signed per the DCO using --signoff
• Commit changes are listed out in CHANGELOG.md file (See: Changelog)
• Public documentation issue/PR created

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.

[github-actions]

Compatibility status:

Checks if related components are compatible with change e0dc610

Incompatible components

Incompatible components: [https://github.com/opensearch-project/performance-analyzer.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/performance-analyzer-rca.git]

Skipped components

Compatible components

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

[github-actions]

❌ Gradle check result for fb324cf: FAILURE

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 result for e0dc610: SUCCESS

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (3c07461) 71.40% compared to head (e0dc610) 71.32%.

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #12117      +/-   ##
============================================
- Coverage     71.40%   71.32%   -0.08%     
+ Complexity    59505    59445      -60     
============================================
  Files          4925     4925              
  Lines        279540   279540              
  Branches      40646    40646              
============================================
- Hits         199594   199382     -212     
- Misses        63314    63535     +221     
+ Partials      16632    16623       -9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.