126 строки
8.8 KiB
YAML
126 строки
8.8 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.amqp.AmqpRetryPolicy"
|
|
fullName: "com.azure.core.amqp.AmqpRetryPolicy"
|
|
name: "AmqpRetryPolicy"
|
|
nameWithType: "AmqpRetryPolicy"
|
|
summary: "An abstract representation of a policy to govern retrying of messaging operations."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public abstract class **AmqpRetryPolicy**"
|
|
constructors:
|
|
- uid: "com.azure.core.amqp.AmqpRetryPolicy.AmqpRetryPolicy(com.azure.core.amqp.AmqpRetryOptions)"
|
|
fullName: "com.azure.core.amqp.AmqpRetryPolicy.AmqpRetryPolicy(AmqpRetryOptions retryOptions)"
|
|
name: "AmqpRetryPolicy(AmqpRetryOptions retryOptions)"
|
|
nameWithType: "AmqpRetryPolicy.AmqpRetryPolicy(AmqpRetryOptions retryOptions)"
|
|
summary: "Creates an instance with the given retry options."
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- description: "The options to set on this retry policy."
|
|
name: "retryOptions"
|
|
type: "<xref href=\"com.azure.core.amqp.AmqpRetryOptions?alt=com.azure.core.amqp.AmqpRetryOptions&text=AmqpRetryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected AmqpRetryPolicy(AmqpRetryOptions retryOptions)"
|
|
desc: "Creates an instance with the given retry options. If <xref uid=\"com.azure.core.amqp.AmqpRetryOptions.getMaxDelay()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AmqpRetryOptions#getMaxDelay()\"></xref>, <xref uid=\"com.azure.core.amqp.AmqpRetryOptions.getDelay()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AmqpRetryOptions#getDelay()\"></xref>, or <xref uid=\"com.azure.core.amqp.AmqpRetryOptions.getMaxRetries()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AmqpRetryOptions#getMaxRetries()\"></xref> is equal to <xref uid=\"java.time.Duration.ZERO\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Duration#ZERO\"></xref> or zero, requests failing with a retriable exception will not be retried."
|
|
methods:
|
|
- uid: "com.azure.core.amqp.AmqpRetryPolicy.calculateRetryDelay(int,java.time.Duration,java.time.Duration,java.util.concurrent.ThreadLocalRandom)"
|
|
fullName: "com.azure.core.amqp.AmqpRetryPolicy.calculateRetryDelay(int retryCount, Duration baseDelay, Duration baseJitter, ThreadLocalRandom random)"
|
|
name: "calculateRetryDelay(int retryCount, Duration baseDelay, Duration baseJitter, ThreadLocalRandom random)"
|
|
nameWithType: "AmqpRetryPolicy.calculateRetryDelay(int retryCount, Duration baseDelay, Duration baseJitter, ThreadLocalRandom random)"
|
|
summary: "Calculates the amount of time to delay before the next retry attempt based on the `retryCount`, `baseDelay`, and `baseJitter`."
|
|
modifiers:
|
|
- "protected"
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The number of attempts that have been made, including the initial attempt before any retries."
|
|
name: "retryCount"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The base delay for a retry attempt."
|
|
name: "baseDelay"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "The base jitter delay."
|
|
name: "baseJitter"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "The random number generator. Can be utilised to calculate a random jitter value for the retry."
|
|
name: "random"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ThreadLocalRandom.html\">ThreadLocalRandom</a>"
|
|
syntax: "protected abstract Duration calculateRetryDelay(int retryCount, Duration baseDelay, Duration baseJitter, ThreadLocalRandom random)"
|
|
desc: "Calculates the amount of time to delay before the next retry attempt based on the `retryCount`, `baseDelay`, and `baseJitter`."
|
|
returns:
|
|
description: "The amount of time to delay before retrying to associated operation; or <code>null</code> if the it cannot be\n retried."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.core.amqp.AmqpRetryPolicy.calculateRetryDelay(java.lang.Throwable,int)"
|
|
fullName: "com.azure.core.amqp.AmqpRetryPolicy.calculateRetryDelay(Throwable lastException, int retryCount)"
|
|
name: "calculateRetryDelay(Throwable lastException, int retryCount)"
|
|
nameWithType: "AmqpRetryPolicy.calculateRetryDelay(Throwable lastException, int retryCount)"
|
|
summary: "Calculates the amount of time to delay before the next retry attempt."
|
|
parameters:
|
|
- description: "The last exception that was observed for the operation to be retried."
|
|
name: "lastException"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html\">Throwable</a>"
|
|
- description: "The number of attempts that have been made, including the initial attempt before any retries."
|
|
name: "retryCount"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Duration calculateRetryDelay(Throwable lastException, int retryCount)"
|
|
desc: "Calculates the amount of time to delay before the next retry attempt."
|
|
returns:
|
|
description: "The amount of time to delay before retrying the associated operation; if <code>null</code>, then the operation\n is no longer eligible to be retried."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.core.amqp.AmqpRetryPolicy.equals(java.lang.Object)"
|
|
fullName: "com.azure.core.amqp.AmqpRetryPolicy.equals(Object obj)"
|
|
name: "equals(Object obj)"
|
|
nameWithType: "AmqpRetryPolicy.equals(Object obj)"
|
|
overridden: "java.lang.Object.equals(java.lang.Object)"
|
|
parameters:
|
|
- name: "obj"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
syntax: "public boolean equals(Object obj)"
|
|
returns:
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.amqp.AmqpRetryPolicy.getMaxRetries()"
|
|
fullName: "com.azure.core.amqp.AmqpRetryPolicy.getMaxRetries()"
|
|
name: "getMaxRetries()"
|
|
nameWithType: "AmqpRetryPolicy.getMaxRetries()"
|
|
summary: "Gets the maximum number of retry attempts."
|
|
syntax: "public int getMaxRetries()"
|
|
desc: "Gets the maximum number of retry attempts."
|
|
returns:
|
|
description: "The maximum number of retry attempts."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.amqp.AmqpRetryPolicy.getRetryOptions()"
|
|
fullName: "com.azure.core.amqp.AmqpRetryPolicy.getRetryOptions()"
|
|
name: "getRetryOptions()"
|
|
nameWithType: "AmqpRetryPolicy.getRetryOptions()"
|
|
summary: "Gets the set of options used to configure this retry policy."
|
|
syntax: "public AmqpRetryOptions getRetryOptions()"
|
|
desc: "Gets the set of options used to configure this retry policy."
|
|
returns:
|
|
description: "The set of options used to configure this retry policy."
|
|
type: "<xref href=\"com.azure.core.amqp.AmqpRetryOptions?alt=com.azure.core.amqp.AmqpRetryOptions&text=AmqpRetryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.amqp.AmqpRetryPolicy.hashCode()"
|
|
fullName: "com.azure.core.amqp.AmqpRetryPolicy.hashCode()"
|
|
name: "hashCode()"
|
|
nameWithType: "AmqpRetryPolicy.hashCode()"
|
|
overridden: "java.lang.Object.hashCode()"
|
|
syntax: "public int hashCode()"
|
|
returns:
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "An abstract representation of a policy to govern retrying of messaging operations."
|
|
metadata: {}
|
|
package: "com.azure.core.amqp"
|
|
artifact: com.azure:azure-core-amqp:2.9.9
|