Class: NetworkApi::PublicNetworksApi
- Inherits:
-
Object
- Object
- NetworkApi::PublicNetworksApi
- Defined in:
- lib/pnap_network_api/api/public_networks_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default) ⇒ PublicNetworksApi
constructor
A new instance of PublicNetworksApi.
-
#public_networks_get(opts = {}) ⇒ Array<PublicNetwork>
List Public Networks.
-
#public_networks_get_with_http_info(opts = {}) ⇒ Array<(Array<PublicNetwork>, Integer, Hash)>
List Public Networks.
-
#public_networks_network_id_delete(public_network_id, opts = {}) ⇒ nil
Delete a Public Network.
-
#public_networks_network_id_delete_with_http_info(public_network_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a Public Network.
-
#public_networks_network_id_get(public_network_id, opts = {}) ⇒ PublicNetwork
Get a Public Network.
-
#public_networks_network_id_get_with_http_info(public_network_id, opts = {}) ⇒ Array<(PublicNetwork, Integer, Hash)>
Get a Public Network.
-
#public_networks_network_id_ip_blocks_ip_block_id_delete(public_network_id, ip_block_id, opts = {}) ⇒ String
Removes the IP Block from the Public Network.
-
#public_networks_network_id_ip_blocks_ip_block_id_delete_with_http_info(public_network_id, ip_block_id, opts = {}) ⇒ Array<(String, Integer, Hash)>
Removes the IP Block from the Public Network.
-
#public_networks_network_id_ip_blocks_post(public_network_id, public_network_ip_block_create, opts = {}) ⇒ PublicNetworkIpBlock
Adds an IP block to this public network.
-
#public_networks_network_id_ip_blocks_post_with_http_info(public_network_id, public_network_ip_block_create, opts = {}) ⇒ Array<(PublicNetworkIpBlock, Integer, Hash)>
Adds an IP block to this public network.
-
#public_networks_network_id_patch(public_network_id, public_network_modify, opts = {}) ⇒ PublicNetwork
Update Public Network’s Details.
-
#public_networks_network_id_patch_with_http_info(public_network_id, public_network_modify, opts = {}) ⇒ Array<(PublicNetwork, Integer, Hash)>
Update Public Network's Details.
-
#public_networks_post(public_network_create, opts = {}) ⇒ PublicNetwork
Create a public network.
-
#public_networks_post_with_http_info(public_network_create, opts = {}) ⇒ Array<(PublicNetwork, Integer, Hash)>
Create a public network.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ PublicNetworksApi
Returns a new instance of PublicNetworksApi.
19 20 21 |
# File 'lib/pnap_network_api/api/public_networks_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/pnap_network_api/api/public_networks_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#public_networks_get(opts = {}) ⇒ Array<PublicNetwork>
List Public Networks. List all Public Networks owned by account.
27 28 29 30 |
# File 'lib/pnap_network_api/api/public_networks_api.rb', line 27 def public_networks_get(opts = {}) data, _status_code, _headers = public_networks_get_with_http_info(opts) data end |
#public_networks_get_with_http_info(opts = {}) ⇒ Array<(Array<PublicNetwork>, Integer, Hash)>
List Public Networks. List all Public Networks owned by account.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/pnap_network_api/api/public_networks_api.rb', line 37 def public_networks_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PublicNetworksApi.public_networks_get ...' end # resource path local_var_path = '/public-networks' # query parameters query_params = opts[:query_params] || {} query_params[:'location'] = opts[:'location'] if !opts[:'location'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array<PublicNetwork>' # auth_names auth_names = opts[:debug_auth_names] || ['OAuth2'] = opts.merge( :operation => :"PublicNetworksApi.public_networks_get", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: PublicNetworksApi#public_networks_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#public_networks_network_id_delete(public_network_id, opts = {}) ⇒ nil
Delete a Public Network. Delete Public Network. The request is accepted only if no resources are members of this network. The IP Block(s) will be freed and can be re-used in the future.
87 88 89 90 |
# File 'lib/pnap_network_api/api/public_networks_api.rb', line 87 def public_networks_network_id_delete(public_network_id, opts = {}) public_networks_network_id_delete_with_http_info(public_network_id, opts) nil end |
#public_networks_network_id_delete_with_http_info(public_network_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a Public Network. Delete Public Network. The request is accepted only if no resources are members of this network. The IP Block(s) will be freed and can be re-used in the future.
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/pnap_network_api/api/public_networks_api.rb', line 97 def public_networks_network_id_delete_with_http_info(public_network_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PublicNetworksApi.public_networks_network_id_delete ...' end # verify the required parameter 'public_network_id' is set if @api_client.config.client_side_validation && public_network_id.nil? fail ArgumentError, "Missing the required parameter 'public_network_id' when calling PublicNetworksApi.public_networks_network_id_delete" end # resource path local_var_path = '/public-networks/{publicNetworkId}'.sub('{' + 'publicNetworkId' + '}', CGI.escape(public_network_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['OAuth2'] = opts.merge( :operation => :"PublicNetworksApi.public_networks_network_id_delete", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: PublicNetworksApi#public_networks_network_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#public_networks_network_id_get(public_network_id, opts = {}) ⇒ PublicNetwork
Get a Public Network. Retrieve Public Network Details.
150 151 152 153 |
# File 'lib/pnap_network_api/api/public_networks_api.rb', line 150 def public_networks_network_id_get(public_network_id, opts = {}) data, _status_code, _headers = public_networks_network_id_get_with_http_info(public_network_id, opts) data end |
#public_networks_network_id_get_with_http_info(public_network_id, opts = {}) ⇒ Array<(PublicNetwork, Integer, Hash)>
Get a Public Network. Retrieve Public Network Details.
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/pnap_network_api/api/public_networks_api.rb', line 160 def public_networks_network_id_get_with_http_info(public_network_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PublicNetworksApi.public_networks_network_id_get ...' end # verify the required parameter 'public_network_id' is set if @api_client.config.client_side_validation && public_network_id.nil? fail ArgumentError, "Missing the required parameter 'public_network_id' when calling PublicNetworksApi.public_networks_network_id_get" end # resource path local_var_path = '/public-networks/{publicNetworkId}'.sub('{' + 'publicNetworkId' + '}', CGI.escape(public_network_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'PublicNetwork' # auth_names auth_names = opts[:debug_auth_names] || ['OAuth2'] = opts.merge( :operation => :"PublicNetworksApi.public_networks_network_id_get", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: PublicNetworksApi#public_networks_network_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#public_networks_network_id_ip_blocks_ip_block_id_delete(public_network_id, ip_block_id, opts = {}) ⇒ String
Removes the IP Block from the Public Network. Removes the IP Block from the Public Network.
Please ensure that no resource members within this network have any IPs assigned from the IP Block being removed.
Defining ‘force` query parameter allows resource assigned IP block to be removed anyway. As a result, traffic addressed to any IP within the block will not be routed to this network anymore.
215 216 217 218 |
# File 'lib/pnap_network_api/api/public_networks_api.rb', line 215 def public_networks_network_id_ip_blocks_ip_block_id_delete(public_network_id, ip_block_id, opts = {}) data, _status_code, _headers = public_networks_network_id_ip_blocks_ip_block_id_delete_with_http_info(public_network_id, ip_block_id, opts) data end |
#public_networks_network_id_ip_blocks_ip_block_id_delete_with_http_info(public_network_id, ip_block_id, opts = {}) ⇒ Array<(String, Integer, Hash)>
Removes the IP Block from the Public Network. Removes the IP Block from the Public Network.<br> Please ensure that no resource members within this network have any IPs assigned from the IP Block being removed.<br> Defining `force` query parameter allows resource assigned IP block to be removed anyway. As a result, traffic addressed to any IP within the block will not be routed to this network anymore.
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/pnap_network_api/api/public_networks_api.rb', line 227 def public_networks_network_id_ip_blocks_ip_block_id_delete_with_http_info(public_network_id, ip_block_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PublicNetworksApi.public_networks_network_id_ip_blocks_ip_block_id_delete ...' end # verify the required parameter 'public_network_id' is set if @api_client.config.client_side_validation && public_network_id.nil? fail ArgumentError, "Missing the required parameter 'public_network_id' when calling PublicNetworksApi.public_networks_network_id_ip_blocks_ip_block_id_delete" end # verify the required parameter 'ip_block_id' is set if @api_client.config.client_side_validation && ip_block_id.nil? fail ArgumentError, "Missing the required parameter 'ip_block_id' when calling PublicNetworksApi.public_networks_network_id_ip_blocks_ip_block_id_delete" end # resource path local_var_path = '/public-networks/{publicNetworkId}/ip-blocks/{ipBlockId}'.sub('{' + 'publicNetworkId' + '}', CGI.escape(public_network_id.to_s)).sub('{' + 'ipBlockId' + '}', CGI.escape(ip_block_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'String' # auth_names auth_names = opts[:debug_auth_names] || ['OAuth2'] = opts.merge( :operation => :"PublicNetworksApi.public_networks_network_id_ip_blocks_ip_block_id_delete", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: PublicNetworksApi#public_networks_network_id_ip_blocks_ip_block_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#public_networks_network_id_ip_blocks_post(public_network_id, public_network_ip_block_create, opts = {}) ⇒ PublicNetworkIpBlock
Adds an IP block to this public network. Adds an IP block to this public network.
286 287 288 289 |
# File 'lib/pnap_network_api/api/public_networks_api.rb', line 286 def public_networks_network_id_ip_blocks_post(public_network_id, public_network_ip_block_create, opts = {}) data, _status_code, _headers = public_networks_network_id_ip_blocks_post_with_http_info(public_network_id, public_network_ip_block_create, opts) data end |
#public_networks_network_id_ip_blocks_post_with_http_info(public_network_id, public_network_ip_block_create, opts = {}) ⇒ Array<(PublicNetworkIpBlock, Integer, Hash)>
Adds an IP block to this public network. Adds an IP block to this public network.
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 |
# File 'lib/pnap_network_api/api/public_networks_api.rb', line 297 def public_networks_network_id_ip_blocks_post_with_http_info(public_network_id, public_network_ip_block_create, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PublicNetworksApi.public_networks_network_id_ip_blocks_post ...' end # verify the required parameter 'public_network_id' is set if @api_client.config.client_side_validation && public_network_id.nil? fail ArgumentError, "Missing the required parameter 'public_network_id' when calling PublicNetworksApi.public_networks_network_id_ip_blocks_post" end # verify the required parameter 'public_network_ip_block_create' is set if @api_client.config.client_side_validation && public_network_ip_block_create.nil? fail ArgumentError, "Missing the required parameter 'public_network_ip_block_create' when calling PublicNetworksApi.public_networks_network_id_ip_blocks_post" end # resource path local_var_path = '/public-networks/{publicNetworkId}/ip-blocks'.sub('{' + 'publicNetworkId' + '}', CGI.escape(public_network_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(public_network_ip_block_create) # return_type return_type = opts[:debug_return_type] || 'PublicNetworkIpBlock' # auth_names auth_names = opts[:debug_auth_names] || ['OAuth2'] = opts.merge( :operation => :"PublicNetworksApi.public_networks_network_id_ip_blocks_post", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: PublicNetworksApi#public_networks_network_id_ip_blocks_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#public_networks_network_id_patch(public_network_id, public_network_modify, opts = {}) ⇒ PublicNetwork
Update Public Network’s Details. Update Public Network’s Details.
360 361 362 363 |
# File 'lib/pnap_network_api/api/public_networks_api.rb', line 360 def public_networks_network_id_patch(public_network_id, public_network_modify, opts = {}) data, _status_code, _headers = public_networks_network_id_patch_with_http_info(public_network_id, public_network_modify, opts) data end |
#public_networks_network_id_patch_with_http_info(public_network_id, public_network_modify, opts = {}) ⇒ Array<(PublicNetwork, Integer, Hash)>
Update Public Network's Details. Update Public Network's Details.
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 |
# File 'lib/pnap_network_api/api/public_networks_api.rb', line 371 def public_networks_network_id_patch_with_http_info(public_network_id, public_network_modify, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PublicNetworksApi.public_networks_network_id_patch ...' end # verify the required parameter 'public_network_id' is set if @api_client.config.client_side_validation && public_network_id.nil? fail ArgumentError, "Missing the required parameter 'public_network_id' when calling PublicNetworksApi.public_networks_network_id_patch" end # verify the required parameter 'public_network_modify' is set if @api_client.config.client_side_validation && public_network_modify.nil? fail ArgumentError, "Missing the required parameter 'public_network_modify' when calling PublicNetworksApi.public_networks_network_id_patch" end # resource path local_var_path = '/public-networks/{publicNetworkId}'.sub('{' + 'publicNetworkId' + '}', CGI.escape(public_network_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(public_network_modify) # return_type return_type = opts[:debug_return_type] || 'PublicNetwork' # auth_names auth_names = opts[:debug_auth_names] || ['OAuth2'] = opts.merge( :operation => :"PublicNetworksApi.public_networks_network_id_patch", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: PublicNetworksApi#public_networks_network_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#public_networks_post(public_network_create, opts = {}) ⇒ PublicNetwork
Create a public network. Create a public network.
433 434 435 436 |
# File 'lib/pnap_network_api/api/public_networks_api.rb', line 433 def public_networks_post(public_network_create, opts = {}) data, _status_code, _headers = public_networks_post_with_http_info(public_network_create, opts) data end |
#public_networks_post_with_http_info(public_network_create, opts = {}) ⇒ Array<(PublicNetwork, Integer, Hash)>
Create a public network. Create a public network.
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 |
# File 'lib/pnap_network_api/api/public_networks_api.rb', line 443 def public_networks_post_with_http_info(public_network_create, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PublicNetworksApi.public_networks_post ...' end # verify the required parameter 'public_network_create' is set if @api_client.config.client_side_validation && public_network_create.nil? fail ArgumentError, "Missing the required parameter 'public_network_create' when calling PublicNetworksApi.public_networks_post" end # resource path local_var_path = '/public-networks' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(public_network_create) # return_type return_type = opts[:debug_return_type] || 'PublicNetwork' # auth_names auth_names = opts[:debug_auth_names] || ['OAuth2'] = opts.merge( :operation => :"PublicNetworksApi.public_networks_post", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: PublicNetworksApi#public_networks_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |