Class ExponentialRetryPolicy

Package version

class: Instantiates a new "ExponentialRetryPolicyFilter" instance.

Hierarchy

BaseRequestPolicy
- ExponentialRetryPolicy

Implements

RequestPolicy

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ExponentialRetryPolicy(nextPolicy: RequestPolicy, options: RequestPolicyOptions, retryCount?: undefined | number, retryInterval?: undefined | number, maxRetryInterval?: undefined | number): ExponentialRetryPolicy

Overrides BaseRequestPolicy.constructor
- Defined in policies/exponentialRetryPolicy.ts:108
constructor

Parameters
- nextPolicy: RequestPolicy
  
  The next RequestPolicy in the pipeline chain.
- options: RequestPolicyOptions
  
  The options for this RequestPolicy.
- Optional retryCount: undefined | number
- Optional retryInterval: undefined | number
- Optional maxRetryInterval: undefined | number
Returns ExponentialRetryPolicy

Properties

_nextPolicy

_nextPolicy: RequestPolicy

_options

_options: RequestPolicyOptions

maxRetryInterval

maxRetryInterval: number

The maximum retry interval in milliseconds.

retryCount

retryCount: number

The client retry count.

retryInterval

retryInterval: number

The client retry interval in milliseconds.

Methods

log

log(logLevel: HttpPipelineLogLevel, message: string): void

Inherited from BaseRequestPolicy.log
- Defined in policies/requestPolicy.ts:43
Attempt to log the provided message to the provided logger. If no logger was provided or if the log level does not meat the logger's threshold, then nothing will be logged.

Parameters
- logLevel: HttpPipelineLogLevel
  
  The log level of this log.
- message: string
  
  The message of this log.
Returns void

sendRequest

sendRequest(request: WebResource): Promise<HttpOperationResponse>

Implementation of RequestPolicy.sendRequest

Overrides BaseRequestPolicy.sendRequest
- Defined in policies/exponentialRetryPolicy.ts:137
Parameters
- request: WebResource
Returns Promise<HttpOperationResponse>

shouldLog

shouldLog(logLevel: HttpPipelineLogLevel): boolean

Inherited from BaseRequestPolicy.shouldLog
- Defined in policies/requestPolicy.ts:33
Get whether or not a log with the provided log level should be logged.

Parameters
- logLevel: HttpPipelineLogLevel
  
  The log level of the log that will be logged.
Returns boolean

Whether or not a log with the provided log level should be logged.

Generated using TypeDoc