Class: NgrokAPI::Services::FailoverBackendsClient
- Inherits:
-
Object
- Object
- NgrokAPI::Services::FailoverBackendsClient
- Defined in:
- lib/ngrokapi/services/failover_backends_client.rb
Overview
A Failover backend defines failover behavior within a list of referenced backends. Traffic is sent to the first backend in the list. If that backend is offline or no connection can be established, ngrok attempts to connect to the next backend in the list until one is successful.
Constant Summary collapse
- PATH =
The API path for the requests
'/backends/failover'
- LIST_PROPERTY =
The List Property from the resulting API for list calls
'backends'
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Instance Method Summary collapse
-
#create(description: "", metadata: "", backends: []) ⇒ NgrokAPI::Models::FailoverBackend
Create a new Failover backend.
-
#create!(description: "", metadata: "", backends: []) ⇒ NgrokAPI::Models::FailoverBackend
Create a new Failover backend Throws an exception if API error.
-
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete a Failover backend by ID.
-
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete a Failover backend by ID.
-
#get(id: "") ⇒ NgrokAPI::Models::FailoverBackend
Get detailed information about a Failover backend by ID.
-
#get!(id: "") ⇒ NgrokAPI::Models::FailoverBackend
Get detailed information about a Failover backend by ID Throws an exception if API error.
-
#initialize(client:) ⇒ FailoverBackendsClient
constructor
A new instance of FailoverBackendsClient.
-
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all Failover backends on this account.
-
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all Failover backends on this account Throws an exception if API error.
-
#update(id: "", description: nil, metadata: nil, backends: []) ⇒ NgrokAPI::Models::FailoverBackend
Update Failover backend by ID.
-
#update!(id: "", description: nil, metadata: nil, backends: []) ⇒ NgrokAPI::Models::FailoverBackend
Update Failover backend by ID Throws an exception if API error.
Constructor Details
#initialize(client:) ⇒ FailoverBackendsClient
Returns a new instance of FailoverBackendsClient.
22 23 24 |
# File 'lib/ngrokapi/services/failover_backends_client.rb', line 22 def initialize(client:) @client = client end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
20 21 22 |
# File 'lib/ngrokapi/services/failover_backends_client.rb', line 20 def client @client end |
Instance Method Details
#create(description: "", metadata: "", backends: []) ⇒ NgrokAPI::Models::FailoverBackend
Create a new Failover backend
35 36 37 38 39 40 41 42 43 44 45 |
# File 'lib/ngrokapi/services/failover_backends_client.rb', line 35 def create(description: "", metadata: "", backends: []) path = '/backends/failover' replacements = { } data = {} data[:description] = description if description data[:metadata] = if data[:backends] = backends if backends result = @client.post(path % replacements, data: data) NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result) end |
#create!(description: "", metadata: "", backends: []) ⇒ NgrokAPI::Models::FailoverBackend
Create a new Failover backend Throws an exception if API error.
57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/ngrokapi/services/failover_backends_client.rb', line 57 def create!(description: "", metadata: "", backends: []) path = '/backends/failover' replacements = { } data = {} data[:description] = description if description data[:metadata] = if data[:backends] = backends if backends result = @client.post(path % replacements, data: data, danger: true) NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result) end |
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete a Failover backend by ID.
76 77 78 79 80 81 82 |
# File 'lib/ngrokapi/services/failover_backends_client.rb', line 76 def delete(id: "") path = '/backends/failover/%{id}' replacements = { id: id, } @client.delete(path % replacements) end |
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete a Failover backend by ID. Throws an exception if API error.
92 93 94 95 96 97 98 |
# File 'lib/ngrokapi/services/failover_backends_client.rb', line 92 def delete!(id: "") path = '/backends/failover/%{id}' replacements = { id: id, } @client.delete(path % replacements, danger: true) end |
#get(id: "") ⇒ NgrokAPI::Models::FailoverBackend
Get detailed information about a Failover backend by ID
107 108 109 110 111 112 113 114 115 |
# File 'lib/ngrokapi/services/failover_backends_client.rb', line 107 def get(id: "") path = '/backends/failover/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data) NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result) end |
#get!(id: "") ⇒ NgrokAPI::Models::FailoverBackend
Get detailed information about a Failover backend by ID Throws an exception if API error.
125 126 127 128 129 130 131 132 133 |
# File 'lib/ngrokapi/services/failover_backends_client.rb', line 125 def get!(id: "") path = '/backends/failover/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data, danger: true) NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result) end |
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all Failover backends on this account
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/ngrokapi/services/failover_backends_client.rb', line 144 def list( before_id: nil, limit: nil, url: nil ) result = @client.list( before_id: before_id, limit: limit, url: url, path: PATH ) NgrokAPI::Models::Listable.new( client: self, attrs: result, list_property: LIST_PROPERTY, klass: NgrokAPI::Models::FailoverBackend ) end |
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all Failover backends on this account Throws an exception if API error.
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/ngrokapi/services/failover_backends_client.rb', line 174 def list!( before_id: nil, limit: nil, url: nil ) result = @client.list( before_id: before_id, limit: limit, danger: true, url: url, path: PATH ) NgrokAPI::Models::Listable.new( client: self, attrs: result, list_property: LIST_PROPERTY, klass: NgrokAPI::Models::FailoverBackend, danger: true ) end |
#update(id: "", description: nil, metadata: nil, backends: []) ⇒ NgrokAPI::Models::FailoverBackend
Update Failover backend by ID
206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/ngrokapi/services/failover_backends_client.rb', line 206 def update(id: "", description: nil, metadata: nil, backends: []) path = '/backends/failover/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if data[:backends] = backends if backends result = @client.patch(path % replacements, data: data) NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result) end |
#update!(id: "", description: nil, metadata: nil, backends: []) ⇒ NgrokAPI::Models::FailoverBackend
Update Failover backend by ID Throws an exception if API error.
230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/ngrokapi/services/failover_backends_client.rb', line 230 def update!(id: "", description: nil, metadata: nil, backends: []) path = '/backends/failover/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if data[:backends] = backends if backends result = @client.patch(path % replacements, data: data, danger: true) NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result) end |