Skip to content

docs: clarify waitTimeout Javadoc for WaiterOverrideConfiguration #7292

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.

Sign up for GitHub

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

Merged
bhoradc merged 5 commits into from
Aug 20, 2026
Merged

docs: clarify waitTimeout Javadoc for WaiterOverrideConfiguration #7292

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3071523
docs: clarify waitTimeout Javadoc in WaiterOverrideConfiguration.Builder
bhoradc Aug 18, 2026
a1066e9
docs: address review nits on WaiterOverrideConfiguration Javadoc
bhoradc Aug 19, 2026
554f950
Merge branch 'master' into bhoradc/fix-waitTimeout-javadoc-5838
bhoradc Aug 19, 2026
26f74a1
Merge branch 'master' into bhoradc/fix-waitTimeout-javadoc-5838
bhoradc Aug 19, 2026
e269839
docs: fix checkstyle line-length violation in waitTimeout Javadoc
bhoradc Aug 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions ...k-core/src/main/java/software/amazon/awssdk/core/waiters/WaiterOverrideConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,11 @@ public Builder maxAttempts(Integer maxAttempts) {
* timeout doesn't have strict guarantees on how quickly a request is aborted when the timeout is breached. The request
* can timeout early if it is determined that the next retry will breach the max wait time. It's disabled by default.
*
* <p>When set, {@code waitTimeout} works alongside {@link #maxAttempts(Integer)}, which caps the number of polling

@joviegas joviegas Aug 19, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nits :

  1. Can we frame waitTimeout as an upper bound rather than a target, and if possible add the concrete Unexpected behavior from waiter if timeout provided #5838 case so it is clear the waiter errors out at the attempt limit, not after the full timeout?

  2. Can we add the note on maxAttempts too so both setters describe the interaction saying maxAttempts works with waitTimeout and waiters transitions to a failure state as soon as it reaches either limit.

@bhoradc bhoradc Aug 19, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Sure, the upper-bound framing with an example helps, revised.

  2. Thought about it initially, and scoped to waitTimeout since it's null by default. The interaction only kicks in when a customer explicitly sets it, and the misinterpretation was directional. But only fair to make it symmetric, added it.

* attempts and has a service-provided default. The waiter transitions to a failure state as soon as either limit
* is reached. To wait longer than the service-provided default, override {@link #maxAttempts(Integer)} to increase
* the number of polling attempts or {@link #backoffStrategyV2(BackoffStrategy)} to lengthen the delay between polls.
*
* @param waitTimeout The new waitTimeout value.
* @return This object for method chaining.
*/
Expand Down
Loading