87 строки
7.0 KiB
YAML
87 строки
7.0 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.http.policy.ExponentialBackoff"
|
|
fullName: "com.azure.core.http.policy.ExponentialBackoff"
|
|
name: "ExponentialBackoff"
|
|
nameWithType: "ExponentialBackoff"
|
|
summary: "A truncated exponential backoff implementation of <xref uid=\"com.azure.core.http.policy.RetryStrategy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryStrategy\"></xref> that has a delay duration that exponentially increases with each retry attempt until an upper bound is reached after which every retry attempt is delayed by the provided max delay duration."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedMembers:
|
|
- "java.lang.Object.clone()"
|
|
- "java.lang.Object.equals(java.lang.Object)"
|
|
- "java.lang.Object.finalize()"
|
|
- "java.lang.Object.getClass()"
|
|
- "java.lang.Object.hashCode()"
|
|
- "java.lang.Object.notify()"
|
|
- "java.lang.Object.notifyAll()"
|
|
- "java.lang.Object.toString()"
|
|
- "java.lang.Object.wait()"
|
|
- "java.lang.Object.wait(long)"
|
|
- "java.lang.Object.wait(long,int)"
|
|
syntax: "public class ExponentialBackoff implements RetryStrategy"
|
|
constructors:
|
|
- uid: "com.azure.core.http.policy.ExponentialBackoff.ExponentialBackoff()"
|
|
fullName: "com.azure.core.http.policy.ExponentialBackoff.ExponentialBackoff()"
|
|
name: "ExponentialBackoff()"
|
|
nameWithType: "ExponentialBackoff.ExponentialBackoff()"
|
|
summary: "Creates an instance of <xref uid=\"com.azure.core.http.policy.ExponentialBackoff\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ExponentialBackoff\"></xref> with a maximum number of retry attempts configured by the environment property <xref uid=\"com.azure.core.util.Configuration.PROPERTY_AZURE_REQUEST_RETRY_COUNT\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration#PROPERTY_AZURE_REQUEST_RETRY_COUNT\"></xref>, or three if it isn't configured or is less than or equal to 0."
|
|
syntax: "public ExponentialBackoff()"
|
|
desc: "Creates an instance of <xref uid=\"com.azure.core.http.policy.ExponentialBackoff\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ExponentialBackoff\"></xref> with a maximum number of retry attempts configured by the environment property <xref uid=\"com.azure.core.util.Configuration.PROPERTY_AZURE_REQUEST_RETRY_COUNT\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration#PROPERTY_AZURE_REQUEST_RETRY_COUNT\"></xref>, or three if it isn't configured or is less than or equal to 0. This strategy starts with a delay of 800 milliseconds and exponentially increases with each additional retry attempt to a maximum of 8 seconds."
|
|
- uid: "com.azure.core.http.policy.ExponentialBackoff.ExponentialBackoff(com.azure.core.http.policy.ExponentialBackoffOptions)"
|
|
fullName: "com.azure.core.http.policy.ExponentialBackoff.ExponentialBackoff(ExponentialBackoffOptions options)"
|
|
name: "ExponentialBackoff(ExponentialBackoffOptions options)"
|
|
nameWithType: "ExponentialBackoff.ExponentialBackoff(ExponentialBackoffOptions options)"
|
|
summary: "Creates an instance of <xref uid=\"com.azure.core.http.policy.ExponentialBackoff\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ExponentialBackoff\"></xref>."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.http.policy.ExponentialBackoffOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ExponentialBackoffOptions\"></xref>."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.core.http.policy.ExponentialBackoffOptions?alt=com.azure.core.http.policy.ExponentialBackoffOptions&text=ExponentialBackoffOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ExponentialBackoff(ExponentialBackoffOptions options)"
|
|
desc: "Creates an instance of <xref uid=\"com.azure.core.http.policy.ExponentialBackoff\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ExponentialBackoff\"></xref>."
|
|
- uid: "com.azure.core.http.policy.ExponentialBackoff.ExponentialBackoff(int,java.time.Duration,java.time.Duration)"
|
|
fullName: "com.azure.core.http.policy.ExponentialBackoff.ExponentialBackoff(int maxRetries, Duration baseDelay, Duration maxDelay)"
|
|
name: "ExponentialBackoff(int maxRetries, Duration baseDelay, Duration maxDelay)"
|
|
nameWithType: "ExponentialBackoff.ExponentialBackoff(int maxRetries, Duration baseDelay, Duration maxDelay)"
|
|
summary: "Creates an instance of <xref uid=\"com.azure.core.http.policy.ExponentialBackoff\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ExponentialBackoff\"></xref>."
|
|
parameters:
|
|
- description: "The max retry attempts that can be made."
|
|
name: "maxRetries"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The base delay duration for retry."
|
|
name: "baseDelay"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "The max delay duration for retry."
|
|
name: "maxDelay"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public ExponentialBackoff(int maxRetries, Duration baseDelay, Duration maxDelay)"
|
|
desc: "Creates an instance of <xref uid=\"com.azure.core.http.policy.ExponentialBackoff\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ExponentialBackoff\"></xref>."
|
|
methods:
|
|
- uid: "com.azure.core.http.policy.ExponentialBackoff.calculateRetryDelay(int)"
|
|
fullName: "com.azure.core.http.policy.ExponentialBackoff.calculateRetryDelay(int retryAttempts)"
|
|
name: "calculateRetryDelay(int retryAttempts)"
|
|
nameWithType: "ExponentialBackoff.calculateRetryDelay(int retryAttempts)"
|
|
summary: "Computes the delay between each retry."
|
|
parameters:
|
|
- name: "retryAttempts"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Duration calculateRetryDelay(int retryAttempts)"
|
|
desc: "Computes the delay between each retry."
|
|
returns:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.core.http.policy.ExponentialBackoff.getMaxRetries()"
|
|
fullName: "com.azure.core.http.policy.ExponentialBackoff.getMaxRetries()"
|
|
name: "getMaxRetries()"
|
|
nameWithType: "ExponentialBackoff.getMaxRetries()"
|
|
summary: "Max number of retry attempts to be make."
|
|
syntax: "public int getMaxRetries()"
|
|
desc: "Max number of retry attempts to be make."
|
|
returns:
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A truncated exponential backoff implementation of <xref uid=\"com.azure.core.http.policy.RetryStrategy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryStrategy\"></xref> that has a delay duration that exponentially increases with each retry attempt until an upper bound is reached after which every retry attempt is delayed by the provided max delay duration."
|
|
implements:
|
|
- "<xref href=\"com.azure.core.http.policy.RetryStrategy?alt=com.azure.core.http.policy.RetryStrategy&text=RetryStrategy\" data-throw-if-not-resolved=\"False\" />"
|
|
metadata: {}
|
|
package: "com.azure.core.http.policy"
|
|
artifact: com.azure:azure-core:1.32.0
|