Class: Google::Apis::CloudschedulerV1::RetryConfig
- Inherits:
-
Object
- Object
- Google::Apis::CloudschedulerV1::RetryConfig
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- generated/google/apis/cloudscheduler_v1/classes.rb,
generated/google/apis/cloudscheduler_v1/representations.rb,
generated/google/apis/cloudscheduler_v1/representations.rb
Overview
Settings that determine the retry behavior. By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig.
Instance Attribute Summary collapse
-
#max_backoff_duration ⇒ String
The maximum amount of time to wait before retrying a job after it fails.
-
#max_doublings ⇒ Fixnum
The time between retries will double
max_doublings
times. -
#max_retry_duration ⇒ String
The time limit for retrying a failed job, measured from time when an execution was first attempted.
-
#min_backoff_duration ⇒ String
The minimum amount of time to wait before retrying a job after it fails.
-
#retry_count ⇒ Fixnum
The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings.
Instance Method Summary collapse
-
#initialize(**args) ⇒ RetryConfig
constructor
A new instance of RetryConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ RetryConfig
Returns a new instance of RetryConfig.
763 764 765 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 763 def initialize(**args) update!(**args) end |
Instance Attribute Details
#max_backoff_duration ⇒ String
The maximum amount of time to wait before retrying a job after it fails. The
default value of this field is 1 hour.
Corresponds to the JSON property maxBackoffDuration
721 722 723 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 721 def max_backoff_duration @max_backoff_duration end |
#max_doublings ⇒ Fixnum
The time between retries will double max_doublings
times. A job's retry
interval starts at min_backoff_duration, then doubles max_doublings
times,
then increases linearly, and finally retries at intervals of
max_backoff_duration up to retry_count times. For example, if
min_backoff_duration is 10s, max_backoff_duration is 300s, and max_doublings
is 3, then the a job will first be retried in 10s. The retry interval will
double three times, and then increase linearly by 2^3 * 10s. Finally, the job
will retry at intervals of max_backoff_duration until the job has been
attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s,
80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5.
Corresponds to the JSON property maxDoublings
735 736 737 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 735 def max_doublings @max_doublings end |
#max_retry_duration ⇒ String
The time limit for retrying a failed job, measured from time when an execution
was first attempted. If specified with retry_count, the job will be retried
until both limits are reached. The default value for max_retry_duration is
zero, which means retry duration is unlimited.
Corresponds to the JSON property maxRetryDuration
743 744 745 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 743 def max_retry_duration @max_retry_duration end |
#min_backoff_duration ⇒ String
The minimum amount of time to wait before retrying a job after it fails. The
default value of this field is 5 seconds.
Corresponds to the JSON property minBackoffDuration
749 750 751 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 749 def min_backoff_duration @min_backoff_duration end |
#retry_count ⇒ Fixnum
The number of attempts that the system will make to run a job using the
exponential backoff procedure described by max_doublings. The default value of
retry_count is zero. If retry_count is zero, a job attempt will not be
retried if it fails. Instead the Cloud Scheduler system will wait for the next
scheduled execution time. If retry_count is set to a non-zero number then
Cloud Scheduler will retry failed attempts, using exponential backoff,
retry_count times, or until the next scheduled execution time, whichever comes
first. Values greater than 5 and negative values are not allowed.
Corresponds to the JSON property retryCount
761 762 763 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 761 def retry_count @retry_count end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
768 769 770 771 772 773 774 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 768 def update!(**args) @max_backoff_duration = args[:max_backoff_duration] if args.key?(:max_backoff_duration) @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_duration = args[:min_backoff_duration] if args.key?(:min_backoff_duration) @retry_count = args[:retry_count] if args.key?(:retry_count) end |