Skip to content

update documentation to make it clearer between seconds and milliseconds #46364

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 2 commits into from
Aug 13, 2025
Merged

update documentation to make it clearer between seconds and milliseconds #46364

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a9e16a
update documentation to make it clearer between seconds and milliseconds
browndav-msft Aug 11, 2025
1b414ba
change javadocs to remove reference to seconds because return is Dura…
browndav-msft Aug 13, 2025
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
19 changes: 10 additions & 9 deletions ...ure-storage-common/src/main/java/com/azure/storage/common/policy/RequestRetryOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ public RequestRetryOptions() {
* <p>This value should be based on the bandwidth available to the host machine and proximity to the Storage
* service, a good starting point may be 60 seconds per MB of anticipated payload size.</p>
* @param retryDelayInMs Optional. Specifies the amount of delay to use before retrying an operation, default value
* is {@code 4ms} when {@code retryPolicyType} is {@link RetryPolicyType#EXPONENTIAL EXPONENTIAL} and {@code 30ms}
* when {@code retryPolicyType} is {@link RetryPolicyType#FIXED FIXED}.
* is {@code 4_000ms} when {@code retryPolicyType} is {@link RetryPolicyType#EXPONENTIAL EXPONENTIAL} and {@code
* 30_000ms} when {@code retryPolicyType} is {@link RetryPolicyType#FIXED FIXED}.
* @param maxRetryDelayInMs Optional. Specifies the maximum delay allowed before retrying an operation, default
* value is {@code 120ms}.
* value is {@code 120_000ms}.
* @param secondaryHost Optional. Specified a secondary Storage account to retry requests against, default is none.
*
* <p>Before setting this understand the issues around reading stale and potentially-inconsistent data, view these
Expand Down Expand Up @@ -195,9 +195,9 @@ public long getRetryDelayInMs() {
}

/**
* Gets the delay between each retry attempt.
* Gets the delay in seconds between each retry attempt.
*
* @return the delay between each retry attempt.
* @return the delay in seconds between each retry attempt.
*/
public Duration getRetryDelay() {
return retryDelay;
Expand All @@ -215,16 +215,16 @@ public long getMaxRetryDelayInMs() {
}

/**
* Gets the maximum delay allowed between each retry.
* Gets the maximum delay in seconds allowed between each retry.
*
* @return the maximum delay allowed between each retry.
* @return the maximum delay in seconds allowed between each retry.
*/
public Duration getMaxRetryDelay() {
return maxRetryDelay;
}

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

/**
* Creates new {@link RequestRetryOptions} from {@link RetryOptions} and let specify storage specific parameters.
* Creates new {@link RequestRetryOptions} from {@link RetryOptions} and let the user specify storage specific
* parameters.
*
* @param retryOptions The {@link RetryOptions}.
* @param tryTimeout Optional. Specified the maximum time allowed before a request is cancelled and
Expand Down