Class: Ionoscloud::TargetGroupsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TargetGroupsApi

Returns a new instance of TargetGroupsApi.



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

def api_client
  @api_client
end

Instance Method Details

#target_groups_delete(target_group_id, opts = {}) ⇒ nil

Remove target groups Remove the specified target group.

Parameters:

  • target_group_id (String) —

    The unique ID of the target group.

  • 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) 


30
31
32
33
 
# File 'lib/ionoscloud/api/target_groups_api.rb', line 30

def target_groups_delete(target_group_id, opts = {})
  target_groups_delete_with_http_info(target_group_id, opts)
  nil
end

#target_groups_delete_with_http_info(target_group_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove target groups Remove the specified target group.

Parameters:

  • target_group_id (String) —

    The unique ID of the target group.

  • 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



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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/ionoscloud/api/target_groups_api.rb', line 43

def target_groups_delete_with_http_info(target_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TargetGroupsApi.target_groups_delete ...'
  end
  # verify the required parameter 'target_group_id' is set
  if @api_client.config.client_side_validation && target_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'target_group_id' when calling TargetGroupsApi.target_groups_delete"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling TargetGroupsApi.target_groups_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 TargetGroupsApi.target_groups_delete, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/targetgroups/{targetGroupId}'.sub('{' + 'targetGroupId' + '}', CGI.escape(target_group_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 => :"TargetGroupsApi.target_groups_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: TargetGroupsApi#target_groups_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#targetgroups_find_by_target_group_id(target_group_id, opts = {}) ⇒ TargetGroup

Retrieve target groups Retrieve the properties of the specified target group.

Parameters:

  • target_group_id (String) —

    The unique ID of the target group.

  • 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:



110
111
112
113
 
# File 'lib/ionoscloud/api/target_groups_api.rb', line 110

def targetgroups_find_by_target_group_id(target_group_id, opts = {})
  data, _status_code, _headers = targetgroups_find_by_target_group_id_with_http_info(target_group_id, opts)
  data
end

#targetgroups_find_by_target_group_id_with_http_info(target_group_id, opts = {}) ⇒ Array<(TargetGroup, Integer, Hash)>

Retrieve target groups Retrieve the properties of the specified target group.

Parameters:

  • target_group_id (String) —

    The unique ID of the target group.

  • 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<(TargetGroup, Integer, Hash)>) —

    TargetGroup data, response status code and response headers



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
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
 
# File 'lib/ionoscloud/api/target_groups_api.rb', line 123

def targetgroups_find_by_target_group_id_with_http_info(target_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TargetGroupsApi.targetgroups_find_by_target_group_id ...'
  end
  # verify the required parameter 'target_group_id' is set
  if @api_client.config.client_side_validation && target_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'target_group_id' when calling TargetGroupsApi.targetgroups_find_by_target_group_id"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling TargetGroupsApi.targetgroups_find_by_target_group_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 TargetGroupsApi.targetgroups_find_by_target_group_id, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/targetgroups/{targetGroupId}'.sub('{' + 'targetGroupId' + '}', CGI.escape(target_group_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] || 'TargetGroup'

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

  new_options = opts.merge(
    :operation => :"TargetGroupsApi.targetgroups_find_by_target_group_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: TargetGroupsApi#targetgroups_find_by_target_group_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#targetgroups_get(opts = {}) ⇒ TargetGroups

List target groups List all target groups.

Parameters:

  • 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 (used together with &lt;b&gt;&lt;i&gt;offset&lt;/i&gt;&lt;/b&gt; for pagination). It must not exceed &lt;b&gt;&lt;i&gt;200&lt;/i&gt;&lt;/b&gt;. (default to 100)

Returns:



191
192
193
194
 
# File 'lib/ionoscloud/api/target_groups_api.rb', line 191

def targetgroups_get(opts = {})
  data, _status_code, _headers = targetgroups_get_with_http_info(opts)
  data
end

#targetgroups_get_with_http_info(opts = {}) ⇒ Array<(TargetGroups, Integer, Hash)>

List target groups List all target groups.

Parameters:

  • 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 (used together with &lt;b&gt;&lt;i&gt;offset&lt;/i&gt;&lt;/b&gt; for pagination). It must not exceed &lt;b&gt;&lt;i&gt;200&lt;/i&gt;&lt;/b&gt;.

Returns:

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

    TargetGroups data, response status code and response headers



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
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
 
# File 'lib/ionoscloud/api/target_groups_api.rb', line 205

def targetgroups_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TargetGroupsApi.targetgroups_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling TargetGroupsApi.targetgroups_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 TargetGroupsApi.targetgroups_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 TargetGroupsApi.targetgroups_get, must be greater than or equal to 0.'
  end

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

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

  # resource path
  local_var_path = '/targetgroups'

  # 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] || 'TargetGroups'

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

  new_options = opts.merge(
    :operation => :"TargetGroupsApi.targetgroups_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: TargetGroupsApi#targetgroups_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#targetgroups_patch(target_group_id, target_group_properties, opts = {}) ⇒ TargetGroup

Partially modify target groups Update the properties of the specified target group.

Parameters:

  • target_group_id (String) —

    The unique ID of the target group.

  • target_group_properties (TargetGroupProperties) —

    The target group properties 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:



283
284
285
286
 
# File 'lib/ionoscloud/api/target_groups_api.rb', line 283

def targetgroups_patch(target_group_id, target_group_properties, opts = {})
  data, _status_code, _headers = targetgroups_patch_with_http_info(target_group_id, target_group_properties, opts)
  data
end

#targetgroups_patch_with_http_info(target_group_id, target_group_properties, opts = {}) ⇒ Array<(TargetGroup, Integer, Hash)>

Partially modify target groups Update the properties of the specified target group.

Parameters:

  • target_group_id (String) —

    The unique ID of the target group.

  • target_group_properties (TargetGroupProperties) —

    The target group properties 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<(TargetGroup, Integer, Hash)>) —

    TargetGroup data, response status code and response headers



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
353
354
355
356
357
358
 
# File 'lib/ionoscloud/api/target_groups_api.rb', line 297

def targetgroups_patch_with_http_info(target_group_id, target_group_properties, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TargetGroupsApi.targetgroups_patch ...'
  end
  # verify the required parameter 'target_group_id' is set
  if @api_client.config.client_side_validation && target_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'target_group_id' when calling TargetGroupsApi.targetgroups_patch"
  end
  # verify the required parameter 'target_group_properties' is set
  if @api_client.config.client_side_validation && target_group_properties.nil?
    fail ArgumentError, "Missing the required parameter 'target_group_properties' when calling TargetGroupsApi.targetgroups_patch"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling TargetGroupsApi.targetgroups_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 TargetGroupsApi.targetgroups_patch, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/targetgroups/{targetGroupId}'.sub('{' + 'targetGroupId' + '}', CGI.escape(target_group_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] || @api_client.object_to_http_body(target_group_properties)

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

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

  new_options = opts.merge(
    :operation => :"TargetGroupsApi.targetgroups_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: TargetGroupsApi#targetgroups_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#targetgroups_post(target_group, opts = {}) ⇒ TargetGroup

Create target groups Create a target group.

Parameters:

  • target_group (TargetGroup) —

    The target group 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:



368
369
370
371
 
# File 'lib/ionoscloud/api/target_groups_api.rb', line 368

def targetgroups_post(target_group, opts = {})
  data, _status_code, _headers = targetgroups_post_with_http_info(target_group, opts)
  data
end

#targetgroups_post_with_http_info(target_group, opts = {}) ⇒ Array<(TargetGroup, Integer, Hash)>

Create target groups Create a target group.

Parameters:

  • target_group (TargetGroup) —

    The target group 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<(TargetGroup, Integer, Hash)>) —

    TargetGroup data, response status code and response headers



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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/ionoscloud/api/target_groups_api.rb', line 381

def targetgroups_post_with_http_info(target_group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TargetGroupsApi.targetgroups_post ...'
  end
  # verify the required parameter 'target_group' is set
  if @api_client.config.client_side_validation && target_group.nil?
    fail ArgumentError, "Missing the required parameter 'target_group' when calling TargetGroupsApi.targetgroups_post"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling TargetGroupsApi.targetgroups_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 TargetGroupsApi.targetgroups_post, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/targetgroups'

  # 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(target_group)

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

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

  new_options = opts.merge(
    :operation => :"TargetGroupsApi.targetgroups_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: TargetGroupsApi#targetgroups_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#targetgroups_put(target_group_id, target_group, opts = {}) ⇒ TargetGroup

Modify target groups Modify the properties of the specified target group.

Parameters:

  • target_group_id (String) —

    The unique ID of the target group.

  • target_group (TargetGroupPut) —

    The modified target group.

  • 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:



451
452
453
454
 
# File 'lib/ionoscloud/api/target_groups_api.rb', line 451

def targetgroups_put(target_group_id, target_group, opts = {})
  data, _status_code, _headers = targetgroups_put_with_http_info(target_group_id, target_group, opts)
  data
end

#targetgroups_put_with_http_info(target_group_id, target_group, opts = {}) ⇒ Array<(TargetGroup, Integer, Hash)>

Modify target groups Modify the properties of the specified target group.

Parameters:

  • target_group_id (String) —

    The unique ID of the target group.

  • target_group (TargetGroupPut) —

    The modified target group.

  • 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<(TargetGroup, Integer, Hash)>) —

    TargetGroup data, response status code and response headers



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
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
 
# File 'lib/ionoscloud/api/target_groups_api.rb', line 465

def targetgroups_put_with_http_info(target_group_id, target_group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TargetGroupsApi.targetgroups_put ...'
  end
  # verify the required parameter 'target_group_id' is set
  if @api_client.config.client_side_validation && target_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'target_group_id' when calling TargetGroupsApi.targetgroups_put"
  end
  # verify the required parameter 'target_group' is set
  if @api_client.config.client_side_validation && target_group.nil?
    fail ArgumentError, "Missing the required parameter 'target_group' when calling TargetGroupsApi.targetgroups_put"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling TargetGroupsApi.targetgroups_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 TargetGroupsApi.targetgroups_put, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/targetgroups/{targetGroupId}'.sub('{' + 'targetGroupId' + '}', CGI.escape(target_group_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(target_group)

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

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

  new_options = opts.merge(
    :operation => :"TargetGroupsApi.targetgroups_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: TargetGroupsApi#targetgroups_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end