Package com.azure.storage.common.policy
Class RequestRetryOptions
java.lang.Object
com.azure.storage.common.policy.RequestRetryOptions
Configuration options for
RequestRetryPolicy
.-
Constructor Summary
ConstructorDescriptionConfigures how theHttpPipeline
should retry requests.RequestRetryOptions
(RetryPolicyType retryPolicyType, Integer maxTries, Integer tryTimeoutInSeconds, Long retryDelayInMs, Long maxRetryDelayInMs, String secondaryHost) Configures how theHttpPipeline
should retry requests.RequestRetryOptions
(RetryPolicyType retryPolicyType, Integer maxTries, Duration tryTimeout, Duration retryDelay, Duration maxRetryDelay, String secondaryHost) Configures how theHttpPipeline
should retry requests. -
Method Summary
Modifier and TypeMethodDescriptionstatic RequestRetryOptions
fromRetryOptions
(com.azure.core.http.policy.RetryOptions retryOptions, Duration tryTimeout, String secondaryHost) Creates newRequestRetryOptions
fromRetryOptions
and let specify storage specific parameters.long
Deprecated.int
long
Deprecated.Please usegetTryTimeoutDuration()
int
Deprecated.Please usegetTryTimeoutDuration()
-
Constructor Details
-
RequestRetryOptions
public RequestRetryOptions()Configures how theHttpPipeline
should retry requests. -
RequestRetryOptions
public RequestRetryOptions(RetryPolicyType retryPolicyType, Integer maxTries, Integer tryTimeoutInSeconds, Long retryDelayInMs, Long maxRetryDelayInMs, String secondaryHost) Configures how theHttpPipeline
should retry requests.- Parameters:
retryPolicyType
- Optional. ARetryPolicyType
specifying the type of retry pattern to use, default value isEXPONENTIAL
.maxTries
- Optional. Maximum number of attempts an operation will be retried, default is4
.tryTimeoutInSeconds
- Optional. Specified the maximum time allowed before a request is cancelled and assumed failed, default isInteger.MAX_VALUE
s.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.
retryDelayInMs
- Optional. Specifies the amount of delay to use before retrying an operation, default value is4ms
whenretryPolicyType
isEXPONENTIAL
and30ms
whenretryPolicyType
isFIXED
.maxRetryDelayInMs
- Optional. Specifies the maximum delay allowed before retrying an operation, default value is120ms
.secondaryHost
- Optional. Specified a secondary Storage account to retry requests against, default is none.Before setting this understand the issues around reading stale and potentially-inconsistent data, view these Azure Docs for more information.
- Throws:
IllegalArgumentException
- IfgetRetryDelayInMs
andgetMaxRetryDelayInMs
are not both null or non-null orretryPolicyType
isn'tRetryPolicyType.EXPONENTIAL
orRetryPolicyType.FIXED
.
-
RequestRetryOptions
public RequestRetryOptions(RetryPolicyType retryPolicyType, Integer maxTries, Duration tryTimeout, Duration retryDelay, Duration maxRetryDelay, String secondaryHost) Configures how theHttpPipeline
should retry requests.- Parameters:
retryPolicyType
- Optional. ARetryPolicyType
specifying the type of retry pattern to use, default value isEXPONENTIAL
.maxTries
- Optional. Maximum number of attempts an operation will be retried, default is4
.tryTimeout
- Optional. Specified the maximum time allowed before a request is cancelled and assumed failed, default isInteger.MAX_VALUE
.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.
retryDelay
- Optional. Specifies the amount of delay to use before retrying an operation, default value is4s
whenretryPolicyType
isEXPONENTIAL
and30s
whenretryPolicyType
isFIXED
.maxRetryDelay
- Optional. Specifies the maximum delay allowed before retrying an operation, default value is120s
.secondaryHost
- Optional. Specified a secondary Storage account to retry requests against, default is none.Before setting this understand the issues around reading stale and potentially-inconsistent data, view these Azure Docs for more information.
- Throws:
IllegalArgumentException
- IfgetRetryDelayInMs
andgetMaxRetryDelayInMs
are not both null or non-null orretryPolicyType
isn'tRetryPolicyType.EXPONENTIAL
orRetryPolicyType.FIXED
.
-
-
Method Details
-
getMaxTries
public int getMaxTries()- Returns:
- the maximum number of retries that will be attempted.
-
getTryTimeout
Deprecated.Please usegetTryTimeoutDuration()
- Returns:
- the maximum time, in seconds, allowed for a request until it is considered timed out.
-
getTryTimeoutDuration
- Returns:
- the maximum time, in seconds, allowed for a request until it is considered timed out.
-
getSecondaryHost
- Returns:
- the URI of the secondary host where retries are attempted. If this is null then there is no secondary host and all retries are attempted against the original host.
-
getRetryDelayInMs
Deprecated.Please usegetTryTimeoutDuration()
- Returns:
- the delay in milliseconds between each retry attempt.
-
getRetryDelay
- Returns:
- the delay between each retry attempt.
-
getMaxRetryDelayInMs
Deprecated.Please usegetTryTimeoutDuration()
- Returns:
- the maximum delay in milliseconds allowed between each retry.
-
getMaxRetryDelay
- Returns:
- the maximum delay allowed between each retry.
-
fromRetryOptions
public static RequestRetryOptions fromRetryOptions(com.azure.core.http.policy.RetryOptions retryOptions, Duration tryTimeout, String secondaryHost) Creates newRequestRetryOptions
fromRetryOptions
and let specify storage specific parameters.- Parameters:
retryOptions
- TheRetryOptions
.tryTimeout
- Optional. Specified the maximum time allowed before a request is cancelled and assumed failed, default isInteger.MAX_VALUE
.secondaryHost
- Optional. Specified a secondary Storage account to retry requests against, default is none.- Returns:
- The
RequestRetryOptions
- Throws:
IllegalArgumentException
- ifretryOptions
can't be mapped toRequestRetryOptions
.
-
getTryTimeoutDuration()