Skip to content

Commit 2747981

Browse files
committed
Update the javadocs
1 parent 12418a0 commit 2747981

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

core/sdk-core/src/main/java/software/amazon/awssdk/core/client/config/SdkClientOption.java

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,22 +64,28 @@ public final class SdkClientOption<T> extends ClientOption<T> {
6464
public static final SdkClientOption<RetryStrategy> RETRY_STRATEGY = new SdkClientOption<>(RetryStrategy.class);
6565

6666
/**
67-
* The internal retry strategy set by the customer. This is likely only useful within configuration
68-
* classes, and will be converted into a {@link #RETRY_STRATEGY} for the SDK's runtime.
67+
* The retry strategy set by the customer using {@link ClientOverrideConfiguration.Builder#retryStrategy(RetryStrategy)}. This
68+
* is likely only useful within configuration classes, and will be converted into a {@link #RETRY_STRATEGY} for the SDK's
69+
* runtime.
70+
*
6971
* @see ClientOverrideConfiguration#retryMode()
7072
*/
7173
public static final SdkClientOption<RetryStrategy> CONFIGURED_RETRY_STRATEGY = new SdkClientOption<>(RetryStrategy.class);
7274

7375
/**
74-
* The internal retry mode set by the customer. This is likely only useful within configuration
75-
* classes, and will be converted into a {@link #RETRY_STRATEGY} for the SDK's runtime.
76+
* The retry mode set by the customer using {@link ClientOverrideConfiguration.Builder#retryStrategy(RetryMode)}. This is
77+
* likely only useful within configuration classes, and will be converted into a {@link #RETRY_STRATEGY} for the SDK's
78+
* runtime.
79+
*
7680
* @see ClientOverrideConfiguration#retryMode()
7781
*/
7882
public static final SdkClientOption<RetryMode> CONFIGURED_RETRY_MODE = new SdkClientOption<>(RetryMode.class);
7983

8084
/**
81-
* The internal consumer to configure the default retry strategy set by the customer. This is likely only useful within
82-
* configuration classes, and will be converted into a {@link #RETRY_STRATEGY} for the SDK's runtime.
85+
* The retry strategy builder consumer set by the customer using
86+
* {@link ClientOverrideConfiguration.Builder#retryStrategy(Consumer<RetryStrategy.Builder>)}. This is likely only useful
87+
* within configuration classes, and will be converted into a {@link #RETRY_STRATEGY} for the SDK's runtime.
88+
*
8389
* @see ClientOverrideConfiguration#retryStrategy()
8490
*/
8591
public static final SdkClientOption<Consumer<RetryStrategy.Builder<?, ?>>> CONFIGURED_RETRY_CONFIGURATOR =

0 commit comments

Comments
 (0)