Class: Google::Apis::CloudtasksV2beta2::RetryConfig

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
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

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ RetryConfig

Returns a new instance of RetryConfig.



1510
1511
1512
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1510

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#max_attemptsFixnum

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

Returns:

  • (Fixnum)


1422
1423
1424
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1422

def max_attempts
  @max_attempts
end

#max_backoffString

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

Returns:

  • (String)


1439
1440
1441
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1439

def max_backoff
  @max_backoff
end

#max_doublingsFixnum

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 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

Returns:

  • (Fixnum)


1466
1467
1468
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1466

def max_doublings
  @max_doublings
end

#max_retry_durationString

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

Returns:

  • (String)


1485
1486
1487
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1485

def max_retry_duration
  @max_retry_duration
end

#min_backoffString

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

Returns:

  • (String)


1502
1503
1504
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1502

def min_backoff
  @min_backoff
end

#unlimited_attemptsBoolean Also known as: unlimited_attempts?

If true, then the number of attempts is unlimited. Corresponds to the JSON property unlimitedAttempts

Returns:

  • (Boolean)


1507
1508
1509
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1507

def unlimited_attempts
  @unlimited_attempts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1515
1516
1517
1518
1519
1520
1521
1522
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1515

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