Class: Ionoscloud::LoadBalancersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ionoscloud/api/load_balancers_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LoadBalancersApi

Returns a new instance of LoadBalancersApi.



19
20
21
 
# File 'lib/ionoscloud/api/load_balancers_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/ionoscloud/api/load_balancers_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#datacenters_loadbalancers_balancednics_delete(datacenter_id, loadbalancer_id, nic_id, opts = {}) ⇒ nil

Detach balanced NICs Detach the specified NIC from the Load Balancer.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer_id (String) —

    The unique ID of the Load Balancer.

  • nic_id (String) —

    The unique ID of the NIC.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines). (default to true)

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 32

def datacenters_loadbalancers_balancednics_delete(datacenter_id, loadbalancer_id, nic_id, opts = {})
  datacenters_loadbalancers_balancednics_delete_with_http_info(datacenter_id, loadbalancer_id, nic_id, opts)
  nil
end

#datacenters_loadbalancers_balancednics_delete_with_http_info(datacenter_id, loadbalancer_id, nic_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Detach balanced NICs Detach the specified NIC from the Load Balancer.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer_id (String) —

    The unique ID of the Load Balancer.

  • nic_id (String) —

    The unique ID of the NIC.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines).

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 47

def datacenters_loadbalancers_balancednics_delete_with_http_info(datacenter_id, loadbalancer_id, nic_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoadBalancersApi.datacenters_loadbalancers_balancednics_delete ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_delete"
  end
  # verify the required parameter 'loadbalancer_id' is set
  if @api_client.config.client_side_validation && loadbalancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'loadbalancer_id' when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_delete"
  end
  # verify the required parameter 'nic_id' is set
  if @api_client.config.client_side_validation && nic_id.nil?
    fail ArgumentError, "Missing the required parameter 'nic_id' when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_delete"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_delete, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_delete, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId}'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'loadbalancerId' + '}', CGI.escape(loadbalancer_id.to_s)).sub('{' + 'nicId' + '}', CGI.escape(nic_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # 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] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"LoadBalancersApi.datacenters_loadbalancers_balancednics_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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoadBalancersApi#datacenters_loadbalancers_balancednics_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#datacenters_loadbalancers_balancednics_find_by_nic_id(datacenter_id, loadbalancer_id, nic_id, opts = {}) ⇒ Nic

Retrieve balanced NICs Retrieve the properties of the specified NIC, attached to the Load Balancer.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer_id (String) —

    The unique ID of the Load Balancer.

  • nic_id (String) —

    The unique ID of the NIC.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines). (default to true)

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:



124
125
126
127
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 124

def datacenters_loadbalancers_balancednics_find_by_nic_id(datacenter_id, loadbalancer_id, nic_id, opts = {})
  data, _status_code, _headers = datacenters_loadbalancers_balancednics_find_by_nic_id_with_http_info(datacenter_id, loadbalancer_id, nic_id, opts)
  data
end

#datacenters_loadbalancers_balancednics_find_by_nic_id_with_http_info(datacenter_id, loadbalancer_id, nic_id, opts = {}) ⇒ Array<(Nic, Integer, Hash)>

Retrieve balanced NICs Retrieve the properties of the specified NIC, attached to the Load Balancer.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer_id (String) —

    The unique ID of the Load Balancer.

  • nic_id (String) —

    The unique ID of the NIC.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines).

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:

  • (Array<(Nic, Integer, Hash)>) —

    Nic data, response status code and response headers



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
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
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 139

def datacenters_loadbalancers_balancednics_find_by_nic_id_with_http_info(datacenter_id, loadbalancer_id, nic_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoadBalancersApi.datacenters_loadbalancers_balancednics_find_by_nic_id ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_find_by_nic_id"
  end
  # verify the required parameter 'loadbalancer_id' is set
  if @api_client.config.client_side_validation && loadbalancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'loadbalancer_id' when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_find_by_nic_id"
  end
  # verify the required parameter 'nic_id' is set
  if @api_client.config.client_side_validation && nic_id.nil?
    fail ArgumentError, "Missing the required parameter 'nic_id' when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_find_by_nic_id"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_find_by_nic_id, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_find_by_nic_id, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId}'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'loadbalancerId' + '}', CGI.escape(loadbalancer_id.to_s)).sub('{' + 'nicId' + '}', CGI.escape(nic_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Nic'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"LoadBalancersApi.datacenters_loadbalancers_balancednics_find_by_nic_id",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoadBalancersApi#datacenters_loadbalancers_balancednics_find_by_nic_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#datacenters_loadbalancers_balancednics_get(datacenter_id, loadbalancer_id, opts = {}) ⇒ BalancedNics

List balanced NICs List all NICs, attached to the specified Load Balancer.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer_id (String) —

    The unique ID of the Load Balancer.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines). (default to true)

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:



215
216
217
218
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 215

def datacenters_loadbalancers_balancednics_get(datacenter_id, loadbalancer_id, opts = {})
  data, _status_code, _headers = datacenters_loadbalancers_balancednics_get_with_http_info(datacenter_id, loadbalancer_id, opts)
  data
end

#datacenters_loadbalancers_balancednics_get_with_http_info(datacenter_id, loadbalancer_id, opts = {}) ⇒ Array<(BalancedNics, Integer, Hash)>

List balanced NICs List all NICs, attached to the specified Load Balancer.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer_id (String) —

    The unique ID of the Load Balancer.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines).

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:

  • (Array<(BalancedNics, Integer, Hash)>) —

    BalancedNics data, response status code and response headers



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
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 229

def datacenters_loadbalancers_balancednics_get_with_http_info(datacenter_id, loadbalancer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoadBalancersApi.datacenters_loadbalancers_balancednics_get ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_get"
  end
  # verify the required parameter 'loadbalancer_id' is set
  if @api_client.config.client_side_validation && loadbalancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'loadbalancer_id' when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_get"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_get, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_get, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'loadbalancerId' + '}', CGI.escape(loadbalancer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BalancedNics'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"LoadBalancersApi.datacenters_loadbalancers_balancednics_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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoadBalancersApi#datacenters_loadbalancers_balancednics_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#datacenters_loadbalancers_balancednics_post(datacenter_id, loadbalancer_id, nic, opts = {}) ⇒ Nic

Attach balanced NICs Attach an existing NIC to the specified Load Balancer.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer_id (String) —

    The unique ID of the Load Balancer.

  • nic (Nic) —

    The NIC to be attached.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines). (default to true)

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:



302
303
304
305
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 302

def datacenters_loadbalancers_balancednics_post(datacenter_id, loadbalancer_id, nic, opts = {})
  data, _status_code, _headers = datacenters_loadbalancers_balancednics_post_with_http_info(datacenter_id, loadbalancer_id, nic, opts)
  data
end

#datacenters_loadbalancers_balancednics_post_with_http_info(datacenter_id, loadbalancer_id, nic, opts = {}) ⇒ Array<(Nic, Integer, Hash)>

Attach balanced NICs Attach an existing NIC to the specified Load Balancer.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer_id (String) —

    The unique ID of the Load Balancer.

  • nic (Nic) —

    The NIC to be attached.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines).

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:

  • (Array<(Nic, Integer, Hash)>) —

    Nic data, response status code and response headers



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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 317

def datacenters_loadbalancers_balancednics_post_with_http_info(datacenter_id, loadbalancer_id, nic, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoadBalancersApi.datacenters_loadbalancers_balancednics_post ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_post"
  end
  # verify the required parameter 'loadbalancer_id' is set
  if @api_client.config.client_side_validation && loadbalancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'loadbalancer_id' when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_post"
  end
  # verify the required parameter 'nic' is set
  if @api_client.config.client_side_validation && nic.nil?
    fail ArgumentError, "Missing the required parameter 'nic' when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_post"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_post, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_balancednics_post, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'loadbalancerId' + '}', CGI.escape(loadbalancer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(nic)

  # return_type
  return_type = opts[:debug_return_type] || 'Nic'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"LoadBalancersApi.datacenters_loadbalancers_balancednics_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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoadBalancersApi#datacenters_loadbalancers_balancednics_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#datacenters_loadbalancers_delete(datacenter_id, loadbalancer_id, opts = {}) ⇒ nil

Delete Load Balancers Remove the specified Load Balancer from the data center.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer_id (String) —

    The unique ID of the Load Balancer.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines). (default to true)

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:

  • (nil) 


395
396
397
398
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 395

def datacenters_loadbalancers_delete(datacenter_id, loadbalancer_id, opts = {})
  datacenters_loadbalancers_delete_with_http_info(datacenter_id, loadbalancer_id, opts)
  nil
end

#datacenters_loadbalancers_delete_with_http_info(datacenter_id, loadbalancer_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Load Balancers Remove the specified Load Balancer from the data center.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer_id (String) —

    The unique ID of the Load Balancer.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines).

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
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
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 409

def datacenters_loadbalancers_delete_with_http_info(datacenter_id, loadbalancer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoadBalancersApi.datacenters_loadbalancers_delete ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LoadBalancersApi.datacenters_loadbalancers_delete"
  end
  # verify the required parameter 'loadbalancer_id' is set
  if @api_client.config.client_side_validation && loadbalancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'loadbalancer_id' when calling LoadBalancersApi.datacenters_loadbalancers_delete"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_delete, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_delete, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'loadbalancerId' + '}', CGI.escape(loadbalancer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # 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] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"LoadBalancersApi.datacenters_loadbalancers_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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoadBalancersApi#datacenters_loadbalancers_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#datacenters_loadbalancers_find_by_id(datacenter_id, loadbalancer_id, opts = {}) ⇒ Loadbalancer

Retrieve Load Balancers Retrieve the properties of the specified Load Balancer within the data center.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer_id (String) —

    The unique ID of the Load Balancer.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines). (default to true)

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:



481
482
483
484
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 481

def datacenters_loadbalancers_find_by_id(datacenter_id, loadbalancer_id, opts = {})
  data, _status_code, _headers = datacenters_loadbalancers_find_by_id_with_http_info(datacenter_id, loadbalancer_id, opts)
  data
end

#datacenters_loadbalancers_find_by_id_with_http_info(datacenter_id, loadbalancer_id, opts = {}) ⇒ Array<(Loadbalancer, Integer, Hash)>

Retrieve Load Balancers Retrieve the properties of the specified Load Balancer within the data center.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer_id (String) —

    The unique ID of the Load Balancer.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines).

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:

  • (Array<(Loadbalancer, Integer, Hash)>) —

    Loadbalancer data, response status code and response headers



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 495

def datacenters_loadbalancers_find_by_id_with_http_info(datacenter_id, loadbalancer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoadBalancersApi.datacenters_loadbalancers_find_by_id ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LoadBalancersApi.datacenters_loadbalancers_find_by_id"
  end
  # verify the required parameter 'loadbalancer_id' is set
  if @api_client.config.client_side_validation && loadbalancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'loadbalancer_id' when calling LoadBalancersApi.datacenters_loadbalancers_find_by_id"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_find_by_id, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_find_by_id, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'loadbalancerId' + '}', CGI.escape(loadbalancer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Loadbalancer'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"LoadBalancersApi.datacenters_loadbalancers_find_by_id",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoadBalancersApi#datacenters_loadbalancers_find_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#datacenters_loadbalancers_get(datacenter_id, opts = {}) ⇒ Loadbalancers

List Load Balancers List all the Load Balancers within the data center.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines). (default to true)

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

  • :offset (Integer) —

    The first element (from the complete list of the elements) to include in the response (used together with &lt;b&gt;&lt;i&gt;limit&lt;/i&gt;&lt;/b&gt; for pagination). (default to 0)

  • :limit (Integer) —

    The maximum number of elements to return (use together with offset for pagination). (default to 1000)

Returns:



568
569
570
571
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 568

def datacenters_loadbalancers_get(datacenter_id, opts = {})
  data, _status_code, _headers = datacenters_loadbalancers_get_with_http_info(datacenter_id, opts)
  data
end

#datacenters_loadbalancers_get_with_http_info(datacenter_id, opts = {}) ⇒ Array<(Loadbalancers, Integer, Hash)>

List Load Balancers List all the Load Balancers within the data center.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines).

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

  • :offset (Integer) —

    The first element (from the complete list of the elements) to include in the response (used together with &lt;b&gt;&lt;i&gt;limit&lt;/i&gt;&lt;/b&gt; for pagination).

  • :limit (Integer) —

    The maximum number of elements to return (use together with offset for pagination).

Returns:

  • (Array<(Loadbalancers, Integer, Hash)>) —

    Loadbalancers data, response status code and response headers



583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 583

def datacenters_loadbalancers_get_with_http_info(datacenter_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoadBalancersApi.datacenters_loadbalancers_get ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LoadBalancersApi.datacenters_loadbalancers_get"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_get, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_get, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling LoadBalancersApi.datacenters_loadbalancers_get, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling LoadBalancersApi.datacenters_loadbalancers_get, must be smaller than or equal to 10000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling LoadBalancersApi.datacenters_loadbalancers_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/datacenters/{datacenterId}/loadbalancers'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Loadbalancers'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"LoadBalancersApi.datacenters_loadbalancers_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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoadBalancersApi#datacenters_loadbalancers_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#datacenters_loadbalancers_patch(datacenter_id, loadbalancer_id, loadbalancer, opts = {}) ⇒ Loadbalancer

Partially modify Load Balancers Update the properties of the specified Load Balancer within the data center.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer_id (String) —

    The unique ID of the Load Balancer.

  • loadbalancer (LoadbalancerProperties) —

    The properties of the Load Balancer to be updated.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines). (default to true)

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:



666
667
668
669
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 666

def datacenters_loadbalancers_patch(datacenter_id, loadbalancer_id, loadbalancer, opts = {})
  data, _status_code, _headers = datacenters_loadbalancers_patch_with_http_info(datacenter_id, loadbalancer_id, loadbalancer, opts)
  data
end

#datacenters_loadbalancers_patch_with_http_info(datacenter_id, loadbalancer_id, loadbalancer, opts = {}) ⇒ Array<(Loadbalancer, Integer, Hash)>

Partially modify Load Balancers Update the properties of the specified Load Balancer within the data center.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer_id (String) —

    The unique ID of the Load Balancer.

  • loadbalancer (LoadbalancerProperties) —

    The properties of the Load Balancer to be updated.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines).

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:

  • (Array<(Loadbalancer, Integer, Hash)>) —

    Loadbalancer data, response status code and response headers



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 681

def datacenters_loadbalancers_patch_with_http_info(datacenter_id, loadbalancer_id, loadbalancer, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoadBalancersApi.datacenters_loadbalancers_patch ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LoadBalancersApi.datacenters_loadbalancers_patch"
  end
  # verify the required parameter 'loadbalancer_id' is set
  if @api_client.config.client_side_validation && loadbalancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'loadbalancer_id' when calling LoadBalancersApi.datacenters_loadbalancers_patch"
  end
  # verify the required parameter 'loadbalancer' is set
  if @api_client.config.client_side_validation && loadbalancer.nil?
    fail ArgumentError, "Missing the required parameter 'loadbalancer' when calling LoadBalancersApi.datacenters_loadbalancers_patch"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_patch, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_patch, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'loadbalancerId' + '}', CGI.escape(loadbalancer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(loadbalancer)

  # return_type
  return_type = opts[:debug_return_type] || 'Loadbalancer'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"LoadBalancersApi.datacenters_loadbalancers_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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoadBalancersApi#datacenters_loadbalancers_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#datacenters_loadbalancers_post(datacenter_id, loadbalancer, opts = {}) ⇒ Loadbalancer

Create Load Balancers Create a Load Balancer within the data center.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer (Loadbalancer) —

    The Load Balancer to create.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines). (default to true)

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:



759
760
761
762
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 759

def datacenters_loadbalancers_post(datacenter_id, loadbalancer, opts = {})
  data, _status_code, _headers = datacenters_loadbalancers_post_with_http_info(datacenter_id, loadbalancer, opts)
  data
end

#datacenters_loadbalancers_post_with_http_info(datacenter_id, loadbalancer, opts = {}) ⇒ Array<(Loadbalancer, Integer, Hash)>

Create Load Balancers Create a Load Balancer within the data center.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer (Loadbalancer) —

    The Load Balancer to create.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines).

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:

  • (Array<(Loadbalancer, Integer, Hash)>) —

    Loadbalancer data, response status code and response headers



773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 773

def datacenters_loadbalancers_post_with_http_info(datacenter_id, loadbalancer, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoadBalancersApi.datacenters_loadbalancers_post ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LoadBalancersApi.datacenters_loadbalancers_post"
  end
  # verify the required parameter 'loadbalancer' is set
  if @api_client.config.client_side_validation && loadbalancer.nil?
    fail ArgumentError, "Missing the required parameter 'loadbalancer' when calling LoadBalancersApi.datacenters_loadbalancers_post"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_post, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_post, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/datacenters/{datacenterId}/loadbalancers'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(loadbalancer)

  # return_type
  return_type = opts[:debug_return_type] || 'Loadbalancer'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"LoadBalancersApi.datacenters_loadbalancers_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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoadBalancersApi#datacenters_loadbalancers_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#datacenters_loadbalancers_put(datacenter_id, loadbalancer_id, loadbalancer, opts = {}) ⇒ Loadbalancer

Modify Load Balancers Modify the properties of the specified Load Balancer within the data center.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer_id (String) —

    The unique ID of the Load Balancer.

  • loadbalancer (Loadbalancer) —

    The modified Load Balancer.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines). (default to true)

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:



848
849
850
851
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 848

def datacenters_loadbalancers_put(datacenter_id, loadbalancer_id, loadbalancer, opts = {})
  data, _status_code, _headers = datacenters_loadbalancers_put_with_http_info(datacenter_id, loadbalancer_id, loadbalancer, opts)
  data
end

#datacenters_loadbalancers_put_with_http_info(datacenter_id, loadbalancer_id, loadbalancer, opts = {}) ⇒ Array<(Loadbalancer, Integer, Hash)>

Modify Load Balancers Modify the properties of the specified Load Balancer within the data center.

Parameters:

  • datacenter_id (String) —

    The unique ID of the data center.

  • loadbalancer_id (String) —

    The unique ID of the Load Balancer.

  • loadbalancer (Loadbalancer) —

    The modified Load Balancer.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines).

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:

  • (Array<(Loadbalancer, Integer, Hash)>) —

    Loadbalancer data, response status code and response headers



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'lib/ionoscloud/api/load_balancers_api.rb', line 863

def datacenters_loadbalancers_put_with_http_info(datacenter_id, loadbalancer_id, loadbalancer, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoadBalancersApi.datacenters_loadbalancers_put ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LoadBalancersApi.datacenters_loadbalancers_put"
  end
  # verify the required parameter 'loadbalancer_id' is set
  if @api_client.config.client_side_validation && loadbalancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'loadbalancer_id' when calling LoadBalancersApi.datacenters_loadbalancers_put"
  end
  # verify the required parameter 'loadbalancer' is set
  if @api_client.config.client_side_validation && loadbalancer.nil?
    fail ArgumentError, "Missing the required parameter 'loadbalancer' when calling LoadBalancersApi.datacenters_loadbalancers_put"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_put, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LoadBalancersApi.datacenters_loadbalancers_put, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'loadbalancerId' + '}', CGI.escape(loadbalancer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(loadbalancer)

  # return_type
  return_type = opts[:debug_return_type] || 'Loadbalancer'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"LoadBalancersApi.datacenters_loadbalancers_put",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoadBalancersApi#datacenters_loadbalancers_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end