RetryOptions interface

Package:

@azure/event-hubs

Retry policy options that determine the mode, number of retries, retry interval etc.

Properties

maxRetries	Number of times the operation needs to be retried in case of retryable error. Default: 3.
maxRetryDelayInMs	Denotes the maximum delay between retries that the retry attempts will be capped at. Applicable only when performing exponential retry.
mode	Denotes which retry mode to apply. If undefined, defaults to Fixed
retryDelayInMs	Amount of time to wait in milliseconds before making the next attempt. Default: 30000 milliseconds. When mode option is set to Exponential, this is used to compute the exponentially increasing delays between retries.
timeoutInMs	Number of milliseconds to wait before declaring that current attempt has timed out which will trigger a retry A minimum value of 60000 milliseconds will be used if a value not greater than this is provided.

Property Details

maxRetries

Number of times the operation needs to be retried in case of retryable error. Default: 3.

maxRetries?: number

Property Value

number

maxRetryDelayInMs

Denotes the maximum delay between retries that the retry attempts will be capped at. Applicable only when performing exponential retry.

maxRetryDelayInMs?: number

Property Value

number

mode

Denotes which retry mode to apply. If undefined, defaults to Fixed

mode?: RetryMode

Property Value

RetryMode

retryDelayInMs

Amount of time to wait in milliseconds before making the next attempt. Default: 30000 milliseconds. When mode option is set to Exponential, this is used to compute the exponentially increasing delays between retries.

retryDelayInMs?: number

Property Value

number

timeoutInMs

Number of milliseconds to wait before declaring that current attempt has timed out which will trigger a retry A minimum value of 60000 milliseconds will be used if a value not greater than this is provided.

timeoutInMs?: number

Property Value

number