Exception: Nfe::RateLimitError

Inherits:

Error

• Object
• StandardError
• Error
• Nfe::RateLimitError

Defined in:

lib/nfe/errors.rb,
sig/nfe/errors.rbs

Overview

HTTP 429 — too many requests. Carries the optional retry_after hint.

Instance Attribute Summary

• #retry_after ⇒ Integer^? readonly

  Seconds to wait before retrying, when advertised.

Attributes inherited from Error

#error_code, #request_id, #response_body, #response_headers, #status_code

Instance Method Summary

• #initialize(message = nil, retry_after: nil) ⇒ RateLimitError constructor

  A new instance of RateLimitError.

Methods inherited from Error

#to_h

Constructor Details

#initialize(message = nil, retry_after: nil) ⇒ RateLimitError

Returns a new instance of RateLimitError.

Parameters:

• retry_after (Integer, nil) (defaults to: nil) —

  from the Retry-After header.

• message (String, nil) (defaults to: nil)
• retry_after: (Integer, nil) (defaults to: nil)
• kwargs (Object)

# File 'lib/nfe/errors.rb', line 77

def initialize(message = nil, retry_after: nil, **)
  super(message, **)
  @retry_after = retry_after
end

Instance Attribute Details

#retry_after ⇒ Integer^? (readonly)

Returns seconds to wait before retrying, when advertised.

Returns:

• (Integer, nil) —

  seconds to wait before retrying, when advertised.

# File 'lib/nfe/errors.rb', line 74

def retry_after
  @retry_after
end