Exception: Tenable::ApiError

Inherits:
Error
  • Object
show all
Defined in:
lib/tenable/error.rb

Overview

Raised for non-success HTTP responses from the Tenable API.

Direct Known Subclasses

RateLimitError

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(msg = nil, status_code: nil, body: nil) ⇒ ApiError

Returns a new instance of ApiError.

Parameters:

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

    custom error message

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

    HTTP status code

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

    response body



27
28
29
30
31
32
33
 
# File 'lib/tenable/error.rb', line 27

def initialize(msg = nil, status_code: nil, body: nil)
  @status_code = status_code
  @body = body
  message = msg || "API request failed with status #{status_code}"
  message = "#{message}: #{body}" if body
  super(message)
end

Instance Attribute Details

#body ⇒ String? (readonly)

Returns the response body.

Returns:

  • (String, nil) —

    the response body



22
23
24
 
# File 'lib/tenable/error.rb', line 22

def body
  @body
end

#status_code ⇒ Integer? (readonly)

Returns the HTTP status code.

Returns:

  • (Integer, nil) —

    the HTTP status code



19
20
21
 
# File 'lib/tenable/error.rb', line 19

def status_code
  @status_code
end