Class: IbmCloudPower::PCloudImagesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ibm_cloud_power/api/p_cloud_images_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PCloudImagesApi

Returns a new instance of PCloudImagesApi.



19
20
21
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_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/ibm_cloud_power/api/p_cloud_images_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#pcloud_cloudinstances_images_delete(cloud_instance_id, image_id, opts = {}) ⇒ Object

Delete an Image from a Cloud Instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • image_id (String) —

    Image ID of a image

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

    the optional parameters

Returns:

  • (Object) 


27
28
29
30
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 27

def pcloud_cloudinstances_images_delete(cloud_instance_id, image_id, opts = {})
  data, _status_code, _headers = pcloud_cloudinstances_images_delete_with_http_info(cloud_instance_id, image_id, opts)
  data
end

#pcloud_cloudinstances_images_delete_with_http_info(cloud_instance_id, image_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete an Image from a Cloud Instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • image_id (String) —

    Image ID of a image

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 37

def pcloud_cloudinstances_images_delete_with_http_info(cloud_instance_id, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudImagesApi.pcloud_cloudinstances_images_delete ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudImagesApi.pcloud_cloudinstances_images_delete"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PCloudImagesApi.pcloud_cloudinstances_images_delete"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/images/{image_id}'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{image_id}', CGI.escape(image_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#pcloud_cloudinstances_images_export_post(cloud_instance_id, image_id, body, opts = {}) ⇒ Object

Export an image This API is deprecated for /pcloud/v2/cloud-instances/cloud_instance_id/images/image_id/export. >Note: Support for this API is available till Oct 2022.

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • image_id (String) —

    Image ID of a image

  • body (ExportImage) —

    Parameters for exporting an image

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

    the optional parameters

Returns:

  • (Object) 


96
97
98
99
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 96

def pcloud_cloudinstances_images_export_post(cloud_instance_id, image_id, body, opts = {})
  data, _status_code, _headers = pcloud_cloudinstances_images_export_post_with_http_info(cloud_instance_id, image_id, body, opts)
  data
end

#pcloud_cloudinstances_images_export_post_with_http_info(cloud_instance_id, image_id, body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Export an image This API is deprecated for /pcloud/v2/cloud-instances/cloud_instance_id/images/image_id/export. >Note: Support for this API is available till Oct 2022.

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • image_id (String) —

    Image ID of a image

  • body (ExportImage) —

    Parameters for exporting an image

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 108

def pcloud_cloudinstances_images_export_post_with_http_info(cloud_instance_id, image_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudImagesApi.pcloud_cloudinstances_images_export_post ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudImagesApi.pcloud_cloudinstances_images_export_post"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PCloudImagesApi.pcloud_cloudinstances_images_export_post"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling PCloudImagesApi.pcloud_cloudinstances_images_export_post"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/images/{image_id}/export'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{image_id}', CGI.escape(image_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#pcloud_cloudinstances_images_get(cloud_instance_id, image_id, opts = {}) ⇒ Image

Detailed info of an image

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • image_id (String) —

    Image ID of a image

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

    the optional parameters

Returns:



174
175
176
177
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 174

def pcloud_cloudinstances_images_get(cloud_instance_id, image_id, opts = {})
  data, _status_code, _headers = pcloud_cloudinstances_images_get_with_http_info(cloud_instance_id, image_id, opts)
  data
end

#pcloud_cloudinstances_images_get_with_http_info(cloud_instance_id, image_id, opts = {}) ⇒ Array<(Image, Integer, Hash)>

Detailed info of an image

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • image_id (String) —

    Image ID of a image

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

    the optional parameters

Returns:

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

    Image data, response status code and response headers



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
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
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 184

def pcloud_cloudinstances_images_get_with_http_info(cloud_instance_id, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudImagesApi.pcloud_cloudinstances_images_get ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudImagesApi.pcloud_cloudinstances_images_get"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PCloudImagesApi.pcloud_cloudinstances_images_get"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/images/{image_id}'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{image_id}', CGI.escape(image_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#pcloud_cloudinstances_images_getall(cloud_instance_id, opts = {}) ⇒ Images

List all images for this cloud instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Returns:



240
241
242
243
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 240

def pcloud_cloudinstances_images_getall(cloud_instance_id, opts = {})
  data, _status_code, _headers = pcloud_cloudinstances_images_getall_with_http_info(cloud_instance_id, opts)
  data
end

#pcloud_cloudinstances_images_getall_with_http_info(cloud_instance_id, opts = {}) ⇒ Array<(Images, Integer, Hash)>

List all images for this cloud instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Returns:

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

    Images data, response status code and response headers



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
291
292
293
294
295
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 249

def pcloud_cloudinstances_images_getall_with_http_info(cloud_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudImagesApi.pcloud_cloudinstances_images_getall ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudImagesApi.pcloud_cloudinstances_images_getall"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/images'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#pcloud_cloudinstances_images_post(cloud_instance_id, body, opts = {}) ⇒ Image

Create a new Image (from available images)

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • body (CreateImage) —

    Parameters for the creation of a new image from available images

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

    the optional parameters

Returns:



302
303
304
305
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 302

def pcloud_cloudinstances_images_post(cloud_instance_id, body, opts = {})
  data, _status_code, _headers = pcloud_cloudinstances_images_post_with_http_info(cloud_instance_id, body, opts)
  data
end

#pcloud_cloudinstances_images_post_with_http_info(cloud_instance_id, body, opts = {}) ⇒ Array<(Image, Integer, Hash)>

Create a new Image (from available images)

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • body (CreateImage) —

    Parameters for the creation of a new image from available images

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

    the optional parameters

Returns:

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

    Image data, response status code and response headers



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
359
360
361
362
363
364
365
366
367
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 312

def pcloud_cloudinstances_images_post_with_http_info(cloud_instance_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudImagesApi.pcloud_cloudinstances_images_post ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudImagesApi.pcloud_cloudinstances_images_post"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling PCloudImagesApi.pcloud_cloudinstances_images_post"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/images'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#pcloud_cloudinstances_stockimages_get(cloud_instance_id, image_id, opts = {}) ⇒ Image

Detailed info of an available stock image

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • image_id (String) —

    Image ID of a image

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

    the optional parameters

Returns:



374
375
376
377
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 374

def pcloud_cloudinstances_stockimages_get(cloud_instance_id, image_id, opts = {})
  data, _status_code, _headers = pcloud_cloudinstances_stockimages_get_with_http_info(cloud_instance_id, image_id, opts)
  data
end

#pcloud_cloudinstances_stockimages_get_with_http_info(cloud_instance_id, image_id, opts = {}) ⇒ Array<(Image, Integer, Hash)>

Detailed info of an available stock image

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • image_id (String) —

    Image ID of a image

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

    the optional parameters

Returns:

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

    Image data, response status code and response headers



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
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 384

def pcloud_cloudinstances_stockimages_get_with_http_info(cloud_instance_id, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudImagesApi.pcloud_cloudinstances_stockimages_get ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudImagesApi.pcloud_cloudinstances_stockimages_get"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PCloudImagesApi.pcloud_cloudinstances_stockimages_get"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images/{image_id}'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{image_id}', CGI.escape(image_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#pcloud_cloudinstances_stockimages_getall(cloud_instance_id, opts = {}) ⇒ Images

List all available stock images

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Options Hash (opts):

  • :sap (Boolean) —

    Include SAP images with get available stock images

  • :vtl (Boolean) —

    Include VTL images with get available stock images

Returns:



442
443
444
445
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 442

def pcloud_cloudinstances_stockimages_getall(cloud_instance_id, opts = {})
  data, _status_code, _headers = pcloud_cloudinstances_stockimages_getall_with_http_info(cloud_instance_id, opts)
  data
end

#pcloud_cloudinstances_stockimages_getall_with_http_info(cloud_instance_id, opts = {}) ⇒ Array<(Images, Integer, Hash)>

List all available stock images

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Options Hash (opts):

  • :sap (Boolean) —

    Include SAP images with get available stock images

  • :vtl (Boolean) —

    Include VTL images with get available stock images

Returns:

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

    Images data, response status code and response headers



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 453

def pcloud_cloudinstances_stockimages_getall_with_http_info(cloud_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudImagesApi.pcloud_cloudinstances_stockimages_getall ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudImagesApi.pcloud_cloudinstances_stockimages_getall"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#pcloud_images_get(image_id, opts = {}) ⇒ Image

Detailed info of an image in the image-catalog This API is deprecated for /pcloud/v1/cloud-instances/cloud_instance_id/stock-images/image_id. >Note: Support for this API will be available till 31st March 2023.

Parameters:

  • image_id (String) —

    Image ID of a image

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

    the optional parameters

Returns:



508
509
510
511
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 508

def pcloud_images_get(image_id, opts = {})
  data, _status_code, _headers = pcloud_images_get_with_http_info(image_id, opts)
  data
end

#pcloud_images_get_with_http_info(image_id, opts = {}) ⇒ Array<(Image, Integer, Hash)>

Detailed info of an image in the image-catalog This API is deprecated for /pcloud/v1/cloud-instances/cloud_instance_id/stock-images/image_id. >Note: Support for this API will be available till 31st March 2023.

Parameters:

  • image_id (String) —

    Image ID of a image

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

    the optional parameters

Returns:

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

    Image data, response status code and response headers



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
557
558
559
560
561
562
563
564
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 518

def pcloud_images_get_with_http_info(image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudImagesApi.pcloud_images_get ...'
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PCloudImagesApi.pcloud_images_get"
  end
  # resource path
  local_var_path = '/pcloud/v1/images/{image_id}'.sub('{image_id}', CGI.escape(image_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#pcloud_images_getall(opts = {}) ⇒ Images

List all the images in the image-catalog This API is deprecated for /pcloud/v1/cloud-instances/cloud_instance_id/stock-images. >Note: Support for this API will be available till 31st March 2023.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sap (Boolean) —

    Include SAP images with get available stock images

  • :vtl (Boolean) —

    Include VTL images with get available stock images

Returns:



572
573
574
575
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 572

def pcloud_images_getall(opts = {})
  data, _status_code, _headers = pcloud_images_getall_with_http_info(opts)
  data
end

#pcloud_images_getall_with_http_info(opts = {}) ⇒ Array<(Images, Integer, Hash)>

List all the images in the image-catalog This API is deprecated for /pcloud/v1/cloud-instances/cloud_instance_id/stock-images. >Note: Support for this API will be available till 31st March 2023.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sap (Boolean) —

    Include SAP images with get available stock images

  • :vtl (Boolean) —

    Include VTL images with get available stock images

Returns:

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

    Images 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
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 583

def pcloud_images_getall_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudImagesApi.pcloud_images_getall ...'
  end
  # resource path
  local_var_path = '/pcloud/v1/images'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#pcloud_v1_cloudinstances_cosimages_get(cloud_instance_id, opts = {}) ⇒ Job

Get detail of last cos-image import job

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Returns:



633
634
635
636
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 633

def pcloud_v1_cloudinstances_cosimages_get(cloud_instance_id, opts = {})
  data, _status_code, _headers = pcloud_v1_cloudinstances_cosimages_get_with_http_info(cloud_instance_id, opts)
  data
end

#pcloud_v1_cloudinstances_cosimages_get_with_http_info(cloud_instance_id, opts = {}) ⇒ Array<(Job, Integer, Hash)>

Get detail of last cos-image import job

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Returns:

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

    Job data, response status code and response headers



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 642

def pcloud_v1_cloudinstances_cosimages_get_with_http_info(cloud_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudImagesApi.pcloud_v1_cloudinstances_cosimages_get ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudImagesApi.pcloud_v1_cloudinstances_cosimages_get"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/cos-images'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#pcloud_v1_cloudinstances_cosimages_post(cloud_instance_id, body, opts = {}) ⇒ JobReference

Create an cos-image import job

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • body (CreateCosImageImportJob) —

    Parameters for the creation of a new cos-image import job

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

    the optional parameters

Returns:



695
696
697
698
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 695

def pcloud_v1_cloudinstances_cosimages_post(cloud_instance_id, body, opts = {})
  data, _status_code, _headers = pcloud_v1_cloudinstances_cosimages_post_with_http_info(cloud_instance_id, body, opts)
  data
end

#pcloud_v1_cloudinstances_cosimages_post_with_http_info(cloud_instance_id, body, opts = {}) ⇒ Array<(JobReference, Integer, Hash)>

Create an cos-image import job

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • body (CreateCosImageImportJob) —

    Parameters for the creation of a new cos-image import job

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

    the optional parameters

Returns:

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

    JobReference data, response status code and response headers



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
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 705

def pcloud_v1_cloudinstances_cosimages_post_with_http_info(cloud_instance_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudImagesApi.pcloud_v1_cloudinstances_cosimages_post ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudImagesApi.pcloud_v1_cloudinstances_cosimages_post"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling PCloudImagesApi.pcloud_v1_cloudinstances_cosimages_post"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/cos-images'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#pcloud_v2_images_export_get(cloud_instance_id, image_id, opts = {}) ⇒ Job

Get detail of last image export job

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • image_id (String) —

    Image ID of a image

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

    the optional parameters

Returns:



767
768
769
770
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 767

def pcloud_v2_images_export_get(cloud_instance_id, image_id, opts = {})
  data, _status_code, _headers = pcloud_v2_images_export_get_with_http_info(cloud_instance_id, image_id, opts)
  data
end

#pcloud_v2_images_export_get_with_http_info(cloud_instance_id, image_id, opts = {}) ⇒ Array<(Job, Integer, Hash)>

Get detail of last image export job

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • image_id (String) —

    Image ID of a image

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

    the optional parameters

Returns:

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

    Job data, response status code and response headers



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
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 777

def pcloud_v2_images_export_get_with_http_info(cloud_instance_id, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudImagesApi.pcloud_v2_images_export_get ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudImagesApi.pcloud_v2_images_export_get"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PCloudImagesApi.pcloud_v2_images_export_get"
  end
  # resource path
  local_var_path = '/pcloud/v2/cloud-instances/{cloud_instance_id}/images/{image_id}/export'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{image_id}', CGI.escape(image_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#pcloud_v2_images_export_post(cloud_instance_id, image_id, body, opts = {}) ⇒ JobReference

Add image export job to the jobs queue

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • image_id (String) —

    Image ID of a image

  • body (ExportImage) —

    Parameters for the export

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

    the optional parameters

Returns:



835
836
837
838
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 835

def pcloud_v2_images_export_post(cloud_instance_id, image_id, body, opts = {})
  data, _status_code, _headers = pcloud_v2_images_export_post_with_http_info(cloud_instance_id, image_id, body, opts)
  data
end

#pcloud_v2_images_export_post_with_http_info(cloud_instance_id, image_id, body, opts = {}) ⇒ Array<(JobReference, Integer, Hash)>

Add image export job to the jobs queue

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • image_id (String) —

    Image ID of a image

  • body (ExportImage) —

    Parameters for the export

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

    the optional parameters

Returns:

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

    JobReference data, response status code and response headers



846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
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
 
# File 'lib/ibm_cloud_power/api/p_cloud_images_api.rb', line 846

def pcloud_v2_images_export_post_with_http_info(cloud_instance_id, image_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudImagesApi.pcloud_v2_images_export_post ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudImagesApi.pcloud_v2_images_export_post"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PCloudImagesApi.pcloud_v2_images_export_post"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling PCloudImagesApi.pcloud_v2_images_export_post"
  end
  # resource path
  local_var_path = '/pcloud/v2/cloud-instances/{cloud_instance_id}/images/{image_id}/export'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{image_id}', CGI.escape(image_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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