Class: Google::Cloud::Scheduler::V1::RetryConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/scheduler/v1/job.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

Instance Attribute Details

#max_backoff_duration ⇒ ::Google::Protobuf::Duration

Returns The maximum amount of time to wait before retrying a job after it fails.

The default value of this field is 1 hour.

Returns:

  • (::Google::Protobuf::Duration) —

    The maximum amount of time to wait before retrying a job after it fails.

    The default value of this field is 1 hour.



246
247
248
249
 
# File 'proto_docs/google/cloud/scheduler/v1/job.rb', line 246

class RetryConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#max_doublings ⇒ ::Integer

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

Returns:

  • (::Integer) —

    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.



246
247
248
249
 
# File 'proto_docs/google/cloud/scheduler/v1/job.rb', line 246

class RetryConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#max_retry_duration ⇒ ::Google::Protobuf::Duration

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

Returns:

  • (::Google::Protobuf::Duration) —

    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.



246
247
248
249
 
# File 'proto_docs/google/cloud/scheduler/v1/job.rb', line 246

class RetryConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#min_backoff_duration ⇒ ::Google::Protobuf::Duration

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

The default value of this field is 5 seconds.

Returns:

  • (::Google::Protobuf::Duration) —

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

    The default value of this field is 5 seconds.



246
247
248
249
 
# File 'proto_docs/google/cloud/scheduler/v1/job.rb', line 246

class RetryConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#retry_count ⇒ ::Integer

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

Returns:

  • (::Integer) —

    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.



246
247
248
249
 
# File 'proto_docs/google/cloud/scheduler/v1/job.rb', line 246

class RetryConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end