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

Show file tree
Hide file tree
Changes from 2 commits
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
9 changes: 9 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 @@ -333,6 +334,10 @@ default B putRawQueryParameter(String name, String value) {
* <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>
* Note that this timeout takes precedence over the value configured at client level via
* {@link ClientOverrideConfiguration.Builder#apiCallTimeout(Duration)}.
*
* @see RequestOverrideConfiguration#apiCallTimeout()
*/
B apiCallTimeout(Duration apiCallTimeout);
Expand All @@ -351,6 +356,10 @@ default B putRawQueryParameter(String name, String value) {
* <p>This may be used together with {@link #apiCallTimeout()} 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>
* Note that this timeout takes precedence over the value configured at client level via
* {@link ClientOverrideConfiguration.Builder#apiCallAttemptTimeout(Duration)}.
*
* @see RequestOverrideConfiguration#apiCallAttemptTimeout()
*/
B apiCallAttemptTimeout(Duration apiCallAttemptTimeout);
Expand Down
9 changes: 9 additions & 0 deletions .../src/main/java/software/amazon/awssdk/core/client/config/ClientOverrideConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ToBuilderIgnoreField;
import software.amazon.awssdk.core.RequestOverrideConfiguration;
import software.amazon.awssdk.core.interceptor.ExecutionAttribute;
import software.amazon.awssdk.core.interceptor.ExecutionAttributes;
import software.amazon.awssdk.core.interceptor.ExecutionInterceptor;
Expand Down Expand Up @@ -372,6 +373,9 @@ default Builder retryPolicy(RetryMode retryMode) {
* <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>
* You can also configure it on a per-request basis via {@link RequestOverrideConfiguration.Builder#apiCallTimeout(Duration)}.
* Note that request-level timeout takes precedence.
*
* @see ClientOverrideConfiguration#apiCallTimeout()
*/
Expand All @@ -394,6 +398,11 @@ default Builder retryPolicy(RetryMode retryMode) {
* <p>This may be used together with {@link #apiCallTimeout()} 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>
* You can also configure it on a per-request basis via
* {@link RequestOverrideConfiguration.Builder#apiCallAttemptTimeout(Duration)}.
* Note that request-level timeout takes precedence.
*
* @see ClientOverrideConfiguration#apiCallAttemptTimeout()
*/
Builder apiCallAttemptTimeout(Duration apiCallAttemptTimeout);
Expand Down