Class: Google::Apis::CloudtasksV2beta2::RetryConfig
- Inherits:
-
Object
- Object
- Google::Apis::CloudtasksV2beta2::RetryConfig
- Defined in:
- generated/google/apis/cloudtasks_v2beta2/classes.rb,
generated/google/apis/cloudtasks_v2beta2/representations.rb,
generated/google/apis/cloudtasks_v2beta2/representations.rb
Overview
Retry config. These settings determine how a failed task attempt is retried.
Instance Attribute Summary collapse
-
#max_attempts ⇒ Fixnum
The maximum number of attempts for a 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.
-
#unlimited_attempts ⇒ Boolean
(also: #unlimited_attempts?)
If true, then the number of attempts is unlimited.
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
1382 1383 1384 |
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1382 def initialize(**args) update!(**args) end |
Instance Attribute Details
#max_attempts ⇒ Fixnum
The maximum number of attempts for a 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 > 0.
Corresponds to the JSON property maxAttempts
1298 1299 1300 |
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1298 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.
This field is output only for pull queues.
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
1314 1315 1316 |
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1314 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 is output only for pull queues.
This field has the same meaning as
max_doublings in queue.yaml/xml.
Corresponds to the JSON property maxDoublings
1340 1341 1342 |
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1340 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.
This field is output only for pull queues.
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
1358 1359 1360 |
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1358 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.
This field is output only for pull queues.
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
1374 1375 1376 |
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1374 def min_backoff @min_backoff end |
#unlimited_attempts ⇒ Boolean Also known as: unlimited_attempts?
If true, then the number of attempts is unlimited.
Corresponds to the JSON property unlimitedAttempts
1379 1380 1381 |
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1379 def unlimited_attempts @unlimited_attempts end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1387 1388 1389 1390 1391 1392 1393 1394 |
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1387 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) @unlimited_attempts = args[:unlimited_attempts] if args.key?(:unlimited_attempts) end |