Skip to content

Commit d9a8bed

Browse files
update documentation to make it clearer between seconds and milliseconds (#46364)
* update documentation to make it clearer between seconds and milliseconds * change javadocs to remove reference to seconds because return is Duration not int
1 parent df5f964 commit d9a8bed

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

sdk/storage/azure-storage-common/src/main/java/com/azure/storage/common/policy/RequestRetryOptions.java

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ public RequestRetryOptions() {
4646
* <p>This value should be based on the bandwidth available to the host machine and proximity to the Storage
4747
* service, a good starting point may be 60 seconds per MB of anticipated payload size.</p>
4848
* @param retryDelayInMs Optional. Specifies the amount of delay to use before retrying an operation, default value
49-
* is {@code 4ms} when {@code retryPolicyType} is {@link RetryPolicyType#EXPONENTIAL EXPONENTIAL} and {@code 30ms}
50-
* when {@code retryPolicyType} is {@link RetryPolicyType#FIXED FIXED}.
49+
* is {@code 4_000ms} when {@code retryPolicyType} is {@link RetryPolicyType#EXPONENTIAL EXPONENTIAL} and {@code
50+
* 30_000ms} when {@code retryPolicyType} is {@link RetryPolicyType#FIXED FIXED}.
5151
* @param maxRetryDelayInMs Optional. Specifies the maximum delay allowed before retrying an operation, default
52-
* value is {@code 120ms}.
52+
* value is {@code 120_000ms}.
5353
* @param secondaryHost Optional. Specified a secondary Storage account to retry requests against, default is none.
5454
*
5555
* <p>Before setting this understand the issues around reading stale and potentially-inconsistent data, view these
@@ -224,7 +224,7 @@ public Duration getMaxRetryDelay() {
224224
}
225225

226226
/**
227-
* Calculates how long to delay before sending the next request.
227+
* Calculates how long in milliseconds to delay before sending the next request.
228228
*
229229
* @param tryCount An {@code int} indicating which try we are on.
230230
* @return A {@code long} value of how many milliseconds to delay.
@@ -258,7 +258,8 @@ private long powOfTwo(int exponent) {
258258
}
259259

260260
/**
261-
* Creates new {@link RequestRetryOptions} from {@link RetryOptions} and let specify storage specific parameters.
261+
* Creates new {@link RequestRetryOptions} from {@link RetryOptions} and let the user specify storage specific
262+
* parameters.
262263
*
263264
* @param retryOptions The {@link RetryOptions}.
264265
* @param tryTimeout Optional. Specified the maximum time allowed before a request is cancelled and

0 commit comments

Comments
 (0)