Class: NgrokAPI::Services::ReservedAddrsClient
- Inherits:
-
Object
- Object
- NgrokAPI::Services::ReservedAddrsClient
- Defined in:
- lib/ngrokapi/services/reserved_addrs_client.rb
Overview
Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.
Constant Summary collapse
- PATH =
The API path for the requests
'/reserved_addrs'
- LIST_PROPERTY =
The List Property from the resulting API for list calls
'reserved_addrs'
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Instance Method Summary collapse
-
#create(description: "", metadata: "", region: "", endpoint_configuration_id: nil) ⇒ NgrokAPI::Models::ReservedAddr
Create a new reserved address.
-
#create!(description: "", metadata: "", region: "", endpoint_configuration_id: nil) ⇒ NgrokAPI::Models::ReservedAddr
Create a new reserved address.
-
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete a reserved address.
-
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete a reserved address.
-
#get(id: "") ⇒ NgrokAPI::Models::ReservedAddr
Get the details of a reserved address.
-
#get!(id: "") ⇒ NgrokAPI::Models::ReservedAddr
Get the details of a reserved address.
-
#initialize(client:) ⇒ ReservedAddrsClient
constructor
A new instance of ReservedAddrsClient.
-
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all reserved addresses on this account.
-
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all reserved addresses on this account.
-
#update(id: "", description: nil, metadata: nil, endpoint_configuration_id: nil) ⇒ NgrokAPI::Models::ReservedAddr
Update the attributes of a reserved address.
-
#update!(id: "", description: nil, metadata: nil, endpoint_configuration_id: nil) ⇒ NgrokAPI::Models::ReservedAddr
Update the attributes of a reserved address.
Constructor Details
#initialize(client:) ⇒ ReservedAddrsClient
Returns a new instance of ReservedAddrsClient.
21 22 23 |
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 21 def initialize(client:) @client = client end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
19 20 21 |
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 19 def client @client end |
Instance Method Details
#create(description: "", metadata: "", region: "", endpoint_configuration_id: nil) ⇒ NgrokAPI::Models::ReservedAddr
Create a new reserved address.
34 35 36 37 38 39 40 41 42 43 44 |
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 34 def create(description: "", metadata: "", region: "", endpoint_configuration_id: nil) path = '/reserved_addrs' replacements = { } data = {} data[:description] = description if description data[:metadata] = if data[:region] = region if region result = @client.post(path % replacements, data: data) NgrokAPI::Models::ReservedAddr.new(client: self, attrs: result) end |
#create!(description: "", metadata: "", region: "", endpoint_configuration_id: nil) ⇒ NgrokAPI::Models::ReservedAddr
Create a new reserved address. Throws an exception if API error.
56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 56 def create!(description: "", metadata: "", region: "", endpoint_configuration_id: nil) path = '/reserved_addrs' replacements = { } data = {} data[:description] = description if description data[:metadata] = if data[:region] = region if region result = @client.post(path % replacements, data: data, danger: true) NgrokAPI::Models::ReservedAddr.new(client: self, attrs: result) end |
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete a reserved address.
75 76 77 78 79 80 81 |
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 75 def delete(id: "") path = '/reserved_addrs/%{id}' replacements = { id: id, } @client.delete(path % replacements) end |
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete a reserved address. Throws an exception if API error.
91 92 93 94 95 96 97 |
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 91 def delete!(id: "") path = '/reserved_addrs/%{id}' replacements = { id: id, } @client.delete(path % replacements, danger: true) end |
#get(id: "") ⇒ NgrokAPI::Models::ReservedAddr
Get the details of a reserved address.
106 107 108 109 110 111 112 113 114 |
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 106 def get(id: "") path = '/reserved_addrs/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data) NgrokAPI::Models::ReservedAddr.new(client: self, attrs: result) end |
#get!(id: "") ⇒ NgrokAPI::Models::ReservedAddr
Get the details of a reserved address. Throws an exception if API error.
124 125 126 127 128 129 130 131 132 |
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 124 def get!(id: "") path = '/reserved_addrs/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data, danger: true) NgrokAPI::Models::ReservedAddr.new(client: self, attrs: result) end |
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all reserved addresses on this account.
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 143 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::ReservedAddr ) end |
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all reserved addresses on this account. Throws an exception if API error.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 173 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::ReservedAddr, danger: true ) end |
#update(id: "", description: nil, metadata: nil, endpoint_configuration_id: nil) ⇒ NgrokAPI::Models::ReservedAddr
Update the attributes of a reserved address.
204 205 206 207 208 209 210 211 212 213 214 |
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 204 def update(id: "", description: nil, metadata: nil, endpoint_configuration_id: nil) path = '/reserved_addrs/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if result = @client.patch(path % replacements, data: data) NgrokAPI::Models::ReservedAddr.new(client: self, attrs: result) end |
#update!(id: "", description: nil, metadata: nil, endpoint_configuration_id: nil) ⇒ NgrokAPI::Models::ReservedAddr
Update the attributes of a reserved address. Throws an exception if API error.
226 227 228 229 230 231 232 233 234 235 236 |
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 226 def update!(id: "", description: nil, metadata: nil, endpoint_configuration_id: nil) path = '/reserved_addrs/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if result = @client.patch(path % replacements, data: data, danger: true) NgrokAPI::Models::ReservedAddr.new(client: self, attrs: result) end |