Class: DataPlaneApi::Configuration
- Inherits:
-
Object
- Object
- DataPlaneApi::Configuration
- Defined in:
- lib/data_plane_api/configuration.rb
Overview
Stores configuration options for the HAProxy Data Plane API.
Instance Attribute Summary collapse
-
#basic_password ⇒ String?
Basic Auth password.
-
#basic_user ⇒ String?
Basic Auth username.
-
#global ⇒ Boolean
readonly
Whether this object is used as a global store of settings.
- #logger ⇒ Logger?
- #timeout ⇒ Integer?
- #url ⇒ String, ...
Instance Method Summary collapse
- #connection ⇒ Faraday::Connection
- #freeze ⇒ void
-
#initialize(url: nil, global: false, basic_user: nil, basic_password: nil, logger: nil, timeout: nil, parent: nil) ⇒ Configuration
constructor
A new instance of Configuration.
- #parent ⇒ self?
Constructor Details
#initialize(url: nil, global: false, basic_user: nil, basic_password: nil, logger: nil, timeout: nil, parent: nil) ⇒ Configuration
Returns a new instance of Configuration.
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/data_plane_api/configuration.rb', line 29 def initialize( url: nil, global: false, basic_user: nil, basic_password: nil, logger: nil, timeout: nil, parent: nil ) @global = global @url = url @basic_user = basic_user @basic_password = basic_password @logger = logger @timeout = timeout @parent = parent @connection = nil return unless global @logger ||= ::Logger.new($stdout) @timeout ||= 10 end |
Instance Attribute Details
#basic_password ⇒ String?
Returns Basic Auth password.
80 81 82 83 84 |
# File 'lib/data_plane_api/configuration.rb', line 80 def basic_password return @basic_password if @global || @basic_password parent.basic_password end |
#basic_user ⇒ String?
Returns Basic Auth username.
73 74 75 76 77 |
# File 'lib/data_plane_api/configuration.rb', line 73 def basic_user return @basic_user if @global || @basic_user parent.basic_user end |
#global ⇒ Boolean (readonly)
Returns whether this object is used as a global store of settings.
20 21 22 |
# File 'lib/data_plane_api/configuration.rb', line 20 def global @global end |
#logger ⇒ Logger?
87 88 89 90 91 |
# File 'lib/data_plane_api/configuration.rb', line 87 def logger return @logger if @global || @logger parent.logger end |
#timeout ⇒ Integer?
94 95 96 97 98 |
# File 'lib/data_plane_api/configuration.rb', line 94 def timeout return @timeout if @global || @timeout parent.timeout end |
#url ⇒ String, ...
66 67 68 69 70 |
# File 'lib/data_plane_api/configuration.rb', line 66 def url return @url if @global || @url parent.url end |
Instance Method Details
#connection ⇒ Faraday::Connection
55 56 57 |
# File 'lib/data_plane_api/configuration.rb', line 55 def connection @connection || build_connection end |
#freeze ⇒ void
This method returns an undefined value.
60 61 62 63 |
# File 'lib/data_plane_api/configuration.rb', line 60 def freeze @connection = build_connection super end |
#parent ⇒ self?
101 102 103 104 105 |
# File 'lib/data_plane_api/configuration.rb', line 101 def parent return if @global @parent || CONFIG end |