Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StorageRetryOptions

Package version

Retry options interface.

export
interface

StorageRetryOptions

Hierarchy

  • StorageRetryOptions

Index

Properties

Optional maxRetryDelayInMs

maxRetryDelayInMs: undefined | number

Optional. Specifies the maximum delay allowed before retrying an operation (default is 120s or 120 * 1000ms). If you specify 0, then you must also specify 0 for retryDelayInMs.

type

{number}

memberof

StorageRetryOptions

Optional maxTries

maxTries: undefined | number

Optional. Max try number of attempts, default is 4. A value of 1 means 1 try and no retries. A value smaller than 1 means default retry number of attempts.

type

{number}

memberof

StorageRetryOptions

Optional retryDelayInMs

retryDelayInMs: undefined | number

Optional. Specifies the amount of delay to use before retrying an operation (default is 4s or 4 * 1000ms). The delay increases (exponentially or linearly) with each retry up to a maximum specified by maxRetryDelayInMs. If you specify 0, then you must also specify 0 for maxRetryDelayInMs.

type

{number}

memberof

StorageRetryOptions

Optional retryPolicyType

retryPolicyType: StorageRetryPolicyType

Optional. StorageRetryPolicyType, default is exponential retry policy.

type

{StorageRetryPolicyType}

memberof

StorageRetryOptions

Optional tryTimeoutInMs

tryTimeoutInMs: undefined | number

Optional. Indicates the maximum time in ms allowed for any single try of an HTTP request. A value of zero or undefined means that you accept our default timeout, 60s or 60 * 1000ms.

NOTE: When transferring large amounts of data, the default TryTimeout will probably not be sufficient. You should override this value based on the bandwidth available to the host machine and proximity to the Storage service. A good starting point may be something like (60 seconds per MB of anticipated-payload-size)

type

{number}

memberof

StorageRetryOptions

Generated using TypeDoc