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



1344
1345
1346
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1344

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

Returns:

  • (Fixnum) 


1274
1275
1276
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1274

def max_attempts
  @max_attempts
end

#max_backoff ⇒ String

The maximum amount of time to wait before retrying a task after it fails. The default is 1 hour.

Returns:

  • (String) 


1288
1289
1290
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1288

def max_backoff
  @max_backoff
end

#max_doublings ⇒ Fixnum

The time between retries increases exponentially max_doublings times. max_doublings is maximum number of times that the interval between failed task retries will be doubled before the interval increases linearly. After max_doublings intervals, the retry interval will be 2^(max_doublings - 1) * RetryConfig.min_backoff.

Returns:

  • (Fixnum) 


1304
1305
1306
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1304

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 RetryConfig.max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited.

  • For App Engine queues, this field is 0 seconds by default.
  • For pull queues, this field is output only and always 0. max_retry_duration will be truncated to the nearest second. This field has the same meaning as task_age_limit in queue.yaml. Corresponds to the JSON property maxRetryDuration

Returns:

  • (String) 


1322
1323
1324
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1322

def max_retry_duration
  @max_retry_duration
end

#min_backoff ⇒ String

The minimum amount of time to wait before retrying a task after it fails.

Returns:

  • (String) 


1336
1337
1338
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1336

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

Returns:

  • (Boolean) 


1341
1342
1343
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1341

def unlimited_attempts
  @unlimited_attempts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1349
1350
1351
1352
1353
1354
1355
1356
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 1349

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