Class: Google::Apis::CloudtasksV2::RetryConfig
- Inherits:
-
Object
- Object
- Google::Apis::CloudtasksV2::RetryConfig
- Defined in:
- generated/google/apis/cloudtasks_v2/classes.rb,
generated/google/apis/cloudtasks_v2/representations.rb,
generated/google/apis/cloudtasks_v2/representations.rb
Overview
Retry config. These settings determine when a failed task attempt is retried.
Instance Attribute Summary collapse
-
#max_attempts ⇒ Fixnum
Number of attempts per task.
-
#max_backoff ⇒ String
A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.
-
#max_doublings ⇒ Fixnum
The time between retries will double
max_doublings
times. -
#max_retry_duration ⇒ String
If positive,
max_retry_duration
specifies the time limit for retrying a failed task, measured from when the task was first attempted. -
#min_backoff ⇒ String
A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.
Instance Method Summary collapse
-
#initialize(**args) ⇒ RetryConfig
constructor
A new instance of RetryConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ RetryConfig
Returns a new instance of RetryConfig.
1328 1329 1330 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1328 def initialize(**args) update!(**args) end |
Instance Attribute Details
#max_attempts ⇒ Fixnum
Number of attempts per task.
Cloud Tasks will attempt the task max_attempts
times (that is, if the
first attempt fails, then there will be max_attempts - 1
retries). Must
be >= -1.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
-1 indicates unlimited attempts.
This field has the same meaning as
task_retry_limit in
queue.yaml/xml.
Corresponds to the JSON property maxAttempts
1250 1251 1252 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1250 def max_attempts @max_attempts end |
#max_backoff ⇒ String
A task will be scheduled for retry between
min_backoff and
max_backoff duration after it fails,
if the queue's RetryConfig specifies that the task should be
retried.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
max_backoff
will be truncated to the nearest second.
This field has the same meaning as
max_backoff_seconds in
queue.yaml/xml.
Corresponds to the JSON property maxBackoff
1266 1267 1268 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1266 def max_backoff @max_backoff end |
#max_doublings ⇒ Fixnum
The time between retries will double max_doublings
times.
A task's retry interval starts at
min_backoff, then doubles
max_doublings
times, then increases linearly, and finally
retries retries at intervals of
max_backoff up to
max_attempts times.
For example, if min_backoff is 10s,
max_backoff is 300s, and
max_doublings
is 3, then the a task will first be retried in
10s. The retry interval will double three times, and then
increase linearly by 2^3 * 10s. Finally, the task will retry at
intervals of max_backoff until the
task has been attempted max_attempts
times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
240s, 300s, 300s, ....
If unspecified when the queue is created, Cloud Tasks will pick the
default.
This field has the same meaning as
max_doublings in
queue.yaml/xml.
Corresponds to the JSON property maxDoublings
1292 1293 1294 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1292 def max_doublings @max_doublings end |
#max_retry_duration ⇒ String
If positive, max_retry_duration
specifies the time limit for
retrying a failed task, measured from when the task was first
attempted. Once max_retry_duration
time has passed and the
task has been attempted max_attempts
times, no further attempts will be made and the task will be
deleted.
If zero, then the task age is unlimited.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
max_retry_duration
will be truncated to the nearest second.
This field has the same meaning as
task_age_limit in
queue.yaml/xml.
Corresponds to the JSON property maxRetryDuration
1310 1311 1312 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1310 def max_retry_duration @max_retry_duration end |
#min_backoff ⇒ String
A task will be scheduled for retry between
min_backoff and
max_backoff duration after it fails,
if the queue's RetryConfig specifies that the task should be
retried.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
min_backoff
will be truncated to the nearest second.
This field has the same meaning as
min_backoff_seconds in
queue.yaml/xml.
Corresponds to the JSON property minBackoff
1326 1327 1328 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1326 def min_backoff @min_backoff end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1333 1334 1335 1336 1337 1338 1339 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1333 def update!(**args) @max_attempts = args[:max_attempts] if args.key?(:max_attempts) @max_backoff = args[:max_backoff] if args.key?(:max_backoff) @max_doublings = args[:max_doublings] if args.key?(:max_doublings) @max_retry_duration = args[:max_retry_duration] if args.key?(:max_retry_duration) @min_backoff = args[:min_backoff] if args.key?(:min_backoff) end |