Skip to content

Improve Javadoc for request-level timeout #3771

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
merged 6 commits into from
Mar 7, 2023
Merged

Improve Javadoc for request-level timeout #3771

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7a819be
Improve Javadoc for request-level timeout
zoewangg Feb 17, 2023
52fd243
Update docs
zoewangg Feb 17, 2023
976b155
Fix checkstyle
zoewangg Feb 21, 2023
4cd6700
Merge branch 'master' into zoewang/javadocImprovement
zoewangg Feb 22, 2023
d17dee3
Merge branch 'master' into zoewang/javadocImprovement
zoewangg Feb 23, 2023
0ae25fe
Merge branch 'master' into zoewang/javadocImprovement
zoewangg Mar 7, 2023
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
7 changes: 7 additions & 0 deletions core/sdk-core/src/main/java/software/amazon/awssdk/core/RequestOverrideConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Immutable;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
import software.amazon.awssdk.core.interceptor.ExecutionAttribute;
import software.amazon.awssdk.core.interceptor.ExecutionAttributes;
import software.amazon.awssdk.core.signer.Signer;
Expand Down Expand Up @@ -101,6 +102,9 @@ public List<ApiName> apiNames() {
* <p>This may be used together with {@link #apiCallAttemptTimeout()} to enforce both a timeout on each individual HTTP
* request (i.e. each retry) and the total time spent on all requests across retries (i.e. the 'api call' time).
*
* <p>
* This will override the {@link ClientOverrideConfiguration#apiCallTimeout()} if it is configured.
*
* @see Builder#apiCallTimeout(Duration)
*/
public Optional<Duration> apiCallTimeout() {
Expand All @@ -120,6 +124,9 @@ public Optional<Duration> apiCallTimeout() {
* request
* (i.e. each retry) and the total time spent on all requests across retries (i.e. the 'api call' time).
*
* <p>
* This will override the {@link ClientOverrideConfiguration#apiCallAttemptTimeout()} if it is configured.
*
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this be added to the builder's setters as well? People are more likely to read the javadoc on the method they're calling (on the builder) instead of the method that the SDK is using (on the override configuration).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah yeah, I thought I did, will update

* @see Builder#apiCallAttemptTimeout(Duration)
*/
public Optional<Duration> apiCallAttemptTimeout() {
Expand Down