Class: Gapic::Operation::RetryPolicy

Inherits:
Common::RetryPolicy show all
Defined in:
lib/gapic/operation/retry_policy.rb

Overview

The policy for retrying operation reloads using an incremental backoff.

A new object instance should be used for every Operation invocation.

Constant Summary collapse

DEFAULT_INITIAL_DELAY =

Returns Default initial delay in seconds.

Returns:

  • (Numeric) —

    Default initial delay in seconds.

10
DEFAULT_MAX_DELAY =

Returns Default maximum delay in seconds.

Returns:

  • (Numeric) —

    Default maximum delay in seconds.

300
DEFAULT_MULTIPLIER =

Returns Default delay scaling factor for subsequent retry attempts.

Returns:

  • (Numeric) —

    Default delay scaling factor for subsequent retry attempts.

1.3
DEFAULT_TIMEOUT =

Returns Default timeout threshold value in seconds.

Returns:

  • (Numeric) —

    Default timeout threshold value in seconds.

3600

Constants inherited from Common::RetryPolicy

Common::RetryPolicy::DEFAULT_RETRY_CODES

Instance Method Summary collapse

Methods inherited from Common::RetryPolicy

#call, #delay, #dup, #initial_delay, #max_delay, #multiplier, #perform_delay!, #perform_delay_count, #retry_codes, #start!, #timeout

Constructor Details

#initialize(initial_delay: nil, multiplier: nil, max_delay: nil, timeout: nil) ⇒ RetryPolicy

Create new Operation RetryPolicy.

Parameters:

  • initial_delay (Numeric) (defaults to: nil) —

    Initial delay in seconds.

  • multiplier (Numeric) (defaults to: nil) —

    The delay scaling factor for each subsequent retry attempt.

  • max_delay (Numeric) (defaults to: nil) —

    Maximum delay in seconds.

  • timeout (Numeric) (defaults to: nil) —

    Timeout threshold value in seconds.



42
43
44
45
46
47
48
49
 
# File 'lib/gapic/operation/retry_policy.rb', line 42

def initialize initial_delay: nil, multiplier: nil, max_delay: nil, timeout: nil
  super(
    initial_delay: initial_delay || DEFAULT_INITIAL_DELAY,
    max_delay: max_delay || DEFAULT_MAX_DELAY,
    multiplier: multiplier || DEFAULT_MULTIPLIER,
    timeout: timeout || DEFAULT_TIMEOUT
  )
end