Class: Ionoscloud::ImagesApi
- Inherits:
-
Object
- Object
- Ionoscloud::ImagesApi
- Defined in:
- lib/ionoscloud/api/images_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#images_delete(image_id, opts = {}) ⇒ nil
Delete images Delete the specified image; this operation is only supported for private images.
-
#images_delete_with_http_info(image_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete images Delete the specified image; this operation is only supported for private images.
-
#images_find_by_id(image_id, opts = {}) ⇒ Image
Retrieve images Retrieve the properties of the specified image.
-
#images_find_by_id_with_http_info(image_id, opts = {}) ⇒ Array<(Image, Integer, Hash)>
Retrieve images Retrieve the properties of the specified image.
-
#images_get(opts = {}) ⇒ Images
List images List all the images within the data center.
-
#images_get_with_http_info(opts = {}) ⇒ Array<(Images, Integer, Hash)>
List images List all the images within the data center.
-
#images_patch(image_id, image, opts = {}) ⇒ Image
Partially modify images Update the properties of the specified image.
-
#images_patch_with_http_info(image_id, image, opts = {}) ⇒ Array<(Image, Integer, Hash)>
Partially modify images Update the properties of the specified image.
-
#images_put(image_id, image, opts = {}) ⇒ Image
Modify images Modify the properties of the specified image.
-
#images_put_with_http_info(image_id, image, opts = {}) ⇒ Array<(Image, Integer, Hash)>
Modify images Modify the properties of the specified image.
-
#initialize(api_client = ApiClient.default) ⇒ ImagesApi
constructor
A new instance of ImagesApi.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/ionoscloud/api/images_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#images_delete(image_id, opts = {}) ⇒ nil
Delete images Delete the specified image; this operation is only supported for private images.
30 31 32 33 |
# File 'lib/ionoscloud/api/images_api.rb', line 30 def images_delete(image_id, opts = {}) images_delete_with_http_info(image_id, opts) nil end |
#images_delete_with_http_info(image_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete images Delete the specified image; this operation is only supported for private images.
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/ionoscloud/api/images_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: ImagesApi.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 ImagesApi.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 ImagesApi.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 ImagesApi.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] # auth_names auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication'] = opts.merge( :operation => :"ImagesApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ImagesApi#images_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#images_find_by_id(image_id, opts = {}) ⇒ Image
Retrieve images Retrieve the properties of the specified image.
110 111 112 113 |
# File 'lib/ionoscloud/api/images_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 |
#images_find_by_id_with_http_info(image_id, opts = {}) ⇒ Array<(Image, Integer, Hash)>
Retrieve images Retrieve the properties of the specified image.
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/ionoscloud/api/images_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: ImagesApi.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 ImagesApi.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 ImagesApi.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 ImagesApi.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'] = opts.merge( :operation => :"ImagesApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ImagesApi#images_find_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#images_get(opts = {}) ⇒ Images
List images List all the images within the data center.
189 190 191 192 |
# File 'lib/ionoscloud/api/images_api.rb', line 189 def images_get(opts = {}) data, _status_code, _headers = images_get_with_http_info(opts) data end |
#images_get_with_http_info(opts = {}) ⇒ Array<(Images, Integer, Hash)>
List images List all the images within the data center.
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 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/ionoscloud/api/images_api.rb', line 201 def images_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ImagesApi.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 ImagesApi.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 ImagesApi.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'] = opts.merge( :operation => :"ImagesApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ImagesApi#images_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#images_patch(image_id, image, opts = {}) ⇒ Image
Partially modify images Update the properties of the specified image.
265 266 267 268 |
# File 'lib/ionoscloud/api/images_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 |
#images_patch_with_http_info(image_id, image, opts = {}) ⇒ Array<(Image, Integer, Hash)>
Partially modify images Update the properties of the specified image.
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/ionoscloud/api/images_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: ImagesApi.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 ImagesApi.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 ImagesApi.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 ImagesApi.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 ImagesApi.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'] = opts.merge( :operation => :"ImagesApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ImagesApi#images_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#images_put(image_id, image, opts = {}) ⇒ Image
Modify images Modify the properties of the specified image.
353 354 355 356 |
# File 'lib/ionoscloud/api/images_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 |
#images_put_with_http_info(image_id, image, opts = {}) ⇒ Array<(Image, Integer, Hash)>
Modify images Modify the properties of the specified image.
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 |
# File 'lib/ionoscloud/api/images_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: ImagesApi.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 ImagesApi.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 ImagesApi.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 ImagesApi.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 ImagesApi.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'] = opts.merge( :operation => :"ImagesApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ImagesApi#images_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |