Exception: BrightData::RateLimitError

Inherits:

HTTPError

• Object
• StandardError
• Error
• HTTPError
• BrightData::RateLimitError

Defined in:

lib/brightdata/errors.rb

Overview

Raised on 429 Too Many Requests responses.

Instance Attribute Summary

• #retry_after ⇒ Integer^? readonly

  Value of the ‘Retry-After` header in seconds, or nil if absent.

Attributes inherited from HTTPError

#body, #response, #status

Instance Method Summary

• #initialize(message, status: 429, body: nil, response: nil, retry_after: nil) ⇒ RateLimitError constructor

  A new instance of RateLimitError.

Constructor Details

#initialize(message, status: 429, body: nil, response: nil, retry_after: nil) ⇒ RateLimitError

Returns a new instance of RateLimitError.

Parameters:

• message (String) —

  human-readable error message

• status (Integer) (defaults to: 429) —

  HTTP status

• body (String, nil) (defaults to: nil) —

  raw response body

• response (Net::HTTPResponse, nil) (defaults to: nil) —

  raw Net::HTTP response

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

  retry delay in seconds

# File 'lib/brightdata/errors.rb', line 53

def initialize(message, status: 429, body: nil, response: nil, retry_after: nil)
  super(message, status:, body:, response:)
  @retry_after = retry_after
end

Instance Attribute Details

#retry_after ⇒ Integer^? (readonly)

Returns value of the ‘Retry-After` header in seconds, or nil if absent.

Returns:

• (Integer, nil) —

  value of the ‘Retry-After` header in seconds, or nil if absent

# File 'lib/brightdata/errors.rb', line 46

def retry_after
  @retry_after
end