/
azure.storage.common.retry.LinearRetry.yml
50 lines (45 loc) · 1.39 KB
/
azure.storage.common.retry.LinearRetry.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
### YamlMime:PythonClass
uid: azure.storage.common.retry.LinearRetry
name: LinearRetry
fullName: azure.storage.common.retry.LinearRetry
module: azure.storage.common.retry
inheritances:
- azure.storage.common.retry._Retry
summary: 'Linear retry.
Constructs a Linear retry object.'
constructor:
syntax: LinearRetry(backoff=15, max_attempts=3, retry_to_secondary=False, random_jitter_range=3)
parameters:
- name: backoff
description: The backoff interval, in seconds, between retries.
defaultValue: '15'
types:
- <xref:int>
- name: max_attempts
description: The maximum number of retry attempts.
defaultValue: '3'
types:
- <xref:int>
- name: retry_to_secondary
description: 'Whether the request should be retried to secondary, if able. This
should
only be enabled of RA-GRS accounts are used and potentially stale data
can be handled.'
defaultValue: 'False'
types:
- <xref:bool>
- name: random_jitter_range
description: 'A number in seconds which indicates a range to jitter/randomize
for the back-off interval.
For example, a random_jitter_range of 3 results in the back-off interval x to
vary between x+3 and x-3.'
defaultValue: '3'
types:
- <xref:int>
methods:
- uid: azure.storage.common.retry.LinearRetry.retry
name: retry
signature: retry(context)
parameters:
- name: context
isRequired: true