class Ionoscloud::ImageApi
Attributes
Public Class Methods
# File lib/ionoscloud/api/image_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Delete an Image
Deletes the specified image. This operation is permitted on private image only. @param image_id [String] @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) 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) @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Object]
# File lib/ionoscloud/api/image_api.rb, line 30 def images_delete(image_id, opts = {}) data, _status_code, _headers = images_delete_with_http_info(image_id, opts) data end
Delete an Image
Deletes the specified image. This operation is permitted on private image only. @param image_id [String] @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) 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 @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(Object
, Integer, Hash)>] Object
data, response status code and response headers
# File lib/ionoscloud/api/image_api.rb, line 43 def images_delete_with_http_info(image_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ImageApi.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 ImageApi.images_delete" end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling ImageApi.images_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 ImageApi.images_delete, must be greater than or equal to 0.' end # resource path local_var_path = '/images/{imageId}'.sub('{' + 'imageId' + '}', CGI.escape(image_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] || 'Object' # auth_names auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication'] new_options = opts.merge( :operation => :"ImageApi.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: ImageApi#images_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieve an Image
Retrieves the attributes of a given image. @param image_id [String] @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) 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) @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Image]
# File lib/ionoscloud/api/image_api.rb, line 110 def images_find_by_id(image_id, opts = {}) data, _status_code, _headers = images_find_by_id_with_http_info(image_id, opts) data end
Retrieve an Image
Retrieves the attributes of a given image. @param image_id [String] @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) 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 @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(Image
, Integer, Hash)>] Image
data, response status code and response headers
# File lib/ionoscloud/api/image_api.rb, line 123 def images_find_by_id_with_http_info(image_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ImageApi.images_find_by_id ...' 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 ImageApi.images_find_by_id" end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling ImageApi.images_find_by_id, must be smaller than or equal to 10.' end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling ImageApi.images_find_by_id, must be greater than or equal to 0.' end # resource path local_var_path = '/images/{imageId}'.sub('{' + 'imageId' + '}', CGI.escape(image_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] || 'Image' # auth_names auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication'] new_options = opts.merge( :operation => :"ImageApi.images_find_by_id", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: ImageApi#images_find_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Images
Retrieve a list of images within the datacenter @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) 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) @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Images]
# File lib/ionoscloud/api/image_api.rb, line 189 def images_get(opts = {}) data, _status_code, _headers = images_get_with_http_info(opts) data end
List Images
Retrieve a list of images within the datacenter @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) 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 @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(Images
, Integer, Hash)>] Images
data, response status code and response headers
# File lib/ionoscloud/api/image_api.rb, line 201 def images_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ImageApi.images_get ...' end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling ImageApi.images_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 ImageApi.images_get, must be greater than or equal to 0.' end # resource path local_var_path = '/images' # 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] || 'Images' # auth_names auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication'] new_options = opts.merge( :operation => :"ImageApi.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: ImageApi#images_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Partially modify an Image
You can use update attributes of a resource @param image_id [String] @param image [ImageProperties] Modified Image
@param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) 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) @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Image]
# File lib/ionoscloud/api/image_api.rb, line 265 def images_patch(image_id, image, opts = {}) data, _status_code, _headers = images_patch_with_http_info(image_id, image, opts) data end
Partially modify an Image
You can use update attributes of a resource @param image_id [String] @param image [ImageProperties] Modified Image
@param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) 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 @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(Image
, Integer, Hash)>] Image
data, response status code and response headers
# File lib/ionoscloud/api/image_api.rb, line 279 def images_patch_with_http_info(image_id, image, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ImageApi.images_patch ...' 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 ImageApi.images_patch" end # verify the required parameter 'image' is set if @api_client.config.client_side_validation && image.nil? fail ArgumentError, "Missing the required parameter 'image' when calling ImageApi.images_patch" end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling ImageApi.images_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 ImageApi.images_patch, must be greater than or equal to 0.' end # resource path local_var_path = '/images/{imageId}'.sub('{' + 'imageId' + '}', CGI.escape(image_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(image) # return_type return_type = opts[:debug_return_type] || 'Image' # auth_names auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication'] new_options = opts.merge( :operation => :"ImageApi.images_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: ImageApi#images_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Modify an Image
You can use update attributes of a resource @param image_id [String] @param image [Image] Modified Image
@param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) 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) @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Image]
# File lib/ionoscloud/api/image_api.rb, line 353 def images_put(image_id, image, opts = {}) data, _status_code, _headers = images_put_with_http_info(image_id, image, opts) data end
Modify an Image
You can use update attributes of a resource @param image_id [String] @param image [Image] Modified Image
@param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) 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 @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(Image
, Integer, Hash)>] Image
data, response status code and response headers
# File lib/ionoscloud/api/image_api.rb, line 367 def images_put_with_http_info(image_id, image, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ImageApi.images_put ...' 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 ImageApi.images_put" end # verify the required parameter 'image' is set if @api_client.config.client_side_validation && image.nil? fail ArgumentError, "Missing the required parameter 'image' when calling ImageApi.images_put" end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling ImageApi.images_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 ImageApi.images_put, must be greater than or equal to 0.' end # resource path local_var_path = '/images/{imageId}'.sub('{' + 'imageId' + '}', CGI.escape(image_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(image) # return_type return_type = opts[:debug_return_type] || 'Image' # auth_names auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication'] new_options = opts.merge( :operation => :"ImageApi.images_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: ImageApi#images_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end