class IbmCloudPower::PCloudImagesApi
Attributes
Public Class Methods
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Delete an image from a cloud instance @param cloud_instance_id [String] Cloud Instance ID of a PCloud Instance @param image_id [String] Image
ID of a image @param [Hash] opts the optional parameters @return [Object]
# 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
Delete an image from a cloud instance @param cloud_instance_id [String] Cloud Instance ID of a PCloud Instance @param image_id [String] Image
ID of a image @param [Hash] opts the optional parameters @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
# 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(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Object' # auth_names auth_names = opts[:auth_names] || [] new_options = opts.merge( :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
Export an image @param cloud_instance_id [String] Cloud Instance ID of a PCloud Instance @param image_id [String] Image
ID of a image @param body [ExportImage] Parameters for exporting an image @param [Hash] opts the optional parameters @return [Object]
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 94 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
Export an image @param cloud_instance_id [String] Cloud Instance ID of a PCloud Instance @param image_id [String] Image
ID of a image @param body [ExportImage] Parameters for exporting an image @param [Hash] opts the optional parameters @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 105 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']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'Object' # auth_names auth_names = opts[:auth_names] || [] new_options = opts.merge( :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
Detailed information of an image @param cloud_instance_id [String] Cloud Instance ID of a PCloud Instance @param image_id [String] Image
ID of a image @param [Hash] opts the optional parameters @return [Image]
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 167 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
Detailed information of an image @param cloud_instance_id [String] Cloud Instance ID of a PCloud Instance @param image_id [String] Image
ID of a image @param [Hash] opts the optional parameters @return [Array<(Image
, Integer, Hash)>] Image
data, response status code and response headers
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 177 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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Image' # auth_names auth_names = opts[:auth_names] || [] new_options = opts.merge( :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
List all of the images for this cloud instance @param cloud_instance_id [String] Cloud Instance ID of a PCloud Instance @param [Hash] opts the optional parameters @return [Images]
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 232 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
List all of the images for this cloud instance @param cloud_instance_id [String] Cloud Instance ID of a PCloud Instance @param [Hash] opts the optional parameters @return [Array<(Images
, Integer, Hash)>] Images
data, response status code and response headers
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 241 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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Images' # auth_names auth_names = opts[:auth_names] || [] new_options = opts.merge( :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
Create a new image from available images @param cloud_instance_id [String] Cloud Instance ID of a PCloud Instance @param body [CreateImage] Parameters for the creation of a new image from available images @param [Hash] opts the optional parameters @return [Image]
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 293 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
Create a new image from available images @param cloud_instance_id [String] Cloud Instance ID of a PCloud Instance @param body [CreateImage] Parameters for the creation of a new image from available images @param [Hash] opts the optional parameters @return [Array<(Image
, Integer, Hash)>] Image
data, response status code and response headers
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 303 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']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'Image' # auth_names auth_names = opts[:auth_names] || [] new_options = opts.merge( :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
Detailed info of an available stock image @param cloud_instance_id [String] Cloud Instance ID of a PCloud Instance @param image_id [String] Image
ID of a image @param [Hash] opts the optional parameters @return [Image]
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 361 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
Detailed info of an available stock image @param cloud_instance_id [String] Cloud Instance ID of a PCloud Instance @param image_id [String] Image
ID of a image @param [Hash] opts the optional parameters @return [Array<(Image
, Integer, Hash)>] Image
data, response status code and response headers
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 371 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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Image' # auth_names auth_names = opts[:auth_names] || [] new_options = opts.merge( :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
List all available stock images @param cloud_instance_id [String] Cloud Instance ID of a PCloud Instance @param [Hash] opts the optional parameters @option opts [Boolean] :sap Include SAP images with get available stock images @return [Images]
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 427 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
List all available stock images @param cloud_instance_id [String] Cloud Instance ID of a PCloud Instance @param [Hash] opts the optional parameters @option opts [Boolean] :sap Include SAP images with get available stock images @return [Array<(Images
, Integer, Hash)>] Images
data, response status code and response headers
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 437 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? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Images' # auth_names auth_names = opts[:auth_names] || [] new_options = opts.merge( :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
Deprecated for /pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/stock-images/{image_id} - Detailed info of an available stock image @param image_id [String] Image
ID of a image @param [Hash] opts the optional parameters @return [Images]
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 489 def pcloud_images_get(image_id, opts = {}) data, _status_code, _headers = pcloud_images_get_with_http_info(image_id, opts) data end
Deprecated for /pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/stock-images/{image_id} - Detailed info of an available stock image @param image_id [String] Image
ID of a image @param [Hash] opts the optional parameters @return [Array<(Images
, Integer, Hash)>] Images
data, response status code and response headers
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 498 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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Images' # auth_names auth_names = opts[:auth_names] || [] new_options = opts.merge( :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
Deprecated for /pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/stock-images - List all available stock images @param [Hash] opts the optional parameters @option opts [Boolean] :sap Include SAP images with get available stock images @return [Images]
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 549 def pcloud_images_getall(opts = {}) data, _status_code, _headers = pcloud_images_getall_with_http_info(opts) data end
Deprecated for /pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/stock-images - List all available stock images @param [Hash] opts the optional parameters @option opts [Boolean] :sap Include SAP images with get available stock images @return [Array<(Images
, Integer, Hash)>] Images
data, response status code and response headers
# File lib/ibm_cloud_power/api/p_cloud_images_api.rb, line 558 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? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Images' # auth_names auth_names = opts[:auth_names] || [] new_options = opts.merge( :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