Class: Nodeum::CloudConnectorsApi
- Inherits:
-
Object
- Object
- Nodeum::CloudConnectorsApi
- Defined in:
- lib/nodeum_sdk/api/cloud_connectors_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_cloud_connector(cloud_connector_body, opts = {}) ⇒ CloudConnector
Creates a new cloud connector.
-
#create_cloud_connector_with_http_info(cloud_connector_body, opts = {}) ⇒ Array<(CloudConnector, Integer, Hash)>
Creates a new cloud connector.
-
#destroy_cloud_connector(cloud_connector_id, opts = {}) ⇒ nil
Destroys a specific cloud connector.
-
#destroy_cloud_connector_with_http_info(cloud_connector_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Destroys a specific cloud connector.
-
#index_cloud_connectors(opts = {}) ⇒ CloudConnectorCollection
Lists all cloud connectors.
-
#index_cloud_connectors_with_http_info(opts = {}) ⇒ Array<(CloudConnectorCollection, Integer, Hash)>
Lists all cloud connectors.
-
#initialize(api_client = ApiClient.default) ⇒ CloudConnectorsApi
constructor
A new instance of CloudConnectorsApi.
-
#show_cloud_connector(cloud_connector_id, opts = {}) ⇒ CloudConnector
Displays a specific cloud connector.
-
#show_cloud_connector_with_http_info(cloud_connector_id, opts = {}) ⇒ Array<(CloudConnector, Integer, Hash)>
Displays a specific cloud connector.
-
#test_cloud_connector(cloud_connector_body, opts = {}) ⇒ ActiveJobStatus
Test an unsaved cloud connector.
-
#test_cloud_connector_with_http_info(cloud_connector_body, opts = {}) ⇒ Array<(ActiveJobStatus, Integer, Hash)>
Test an unsaved cloud connector.
-
#test_result_cloud_connector(job_id, opts = {}) ⇒ CloudBucketSimpleCollection
Check result of cloud connector test job.
-
#test_result_cloud_connector_with_http_info(job_id, opts = {}) ⇒ Array<(CloudBucketSimpleCollection, Integer, Hash)>
Check result of cloud connector test job.
-
#update_cloud_connector(cloud_connector_id, cloud_connector_body, opts = {}) ⇒ CloudConnector
Updates a specific cloud connector.
-
#update_cloud_connector_with_http_info(cloud_connector_id, cloud_connector_body, opts = {}) ⇒ Array<(CloudConnector, Integer, Hash)>
Updates a specific cloud connector.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ CloudConnectorsApi
Returns a new instance of CloudConnectorsApi.
19 20 21 |
# File 'lib/nodeum_sdk/api/cloud_connectors_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/nodeum_sdk/api/cloud_connectors_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_cloud_connector(cloud_connector_body, opts = {}) ⇒ CloudConnector
Creates a new cloud connector. **API Key Scope**: cloud_connectors / create
27 28 29 30 |
# File 'lib/nodeum_sdk/api/cloud_connectors_api.rb', line 27 def create_cloud_connector(cloud_connector_body, opts = {}) data, _status_code, _headers = create_cloud_connector_with_http_info(cloud_connector_body, opts) data end |
#create_cloud_connector_with_http_info(cloud_connector_body, opts = {}) ⇒ Array<(CloudConnector, Integer, Hash)>
Creates a new cloud connector. **API Key Scope**: cloud_connectors / create
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 |
# File 'lib/nodeum_sdk/api/cloud_connectors_api.rb', line 37 def create_cloud_connector_with_http_info(cloud_connector_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudConnectorsApi.create_cloud_connector ...' end # verify the required parameter 'cloud_connector_body' is set if @api_client.config.client_side_validation && cloud_connector_body.nil? fail ArgumentError, "Missing the required parameter 'cloud_connector_body' when calling CloudConnectorsApi.create_cloud_connector" end # resource path local_var_path = '/cloud_connectors' # 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(cloud_connector_body) # return_type return_type = opts[:return_type] || 'CloudConnector' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudConnectorsApi#create_cloud_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#destroy_cloud_connector(cloud_connector_id, opts = {}) ⇒ nil
Destroys a specific cloud connector. **API Key Scope**: cloud_connectors / destroy
91 92 93 94 |
# File 'lib/nodeum_sdk/api/cloud_connectors_api.rb', line 91 def destroy_cloud_connector(cloud_connector_id, opts = {}) destroy_cloud_connector_with_http_info(cloud_connector_id, opts) nil end |
#destroy_cloud_connector_with_http_info(cloud_connector_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Destroys a specific cloud connector. **API Key Scope**: cloud_connectors / destroy
101 102 103 104 105 106 107 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 |
# File 'lib/nodeum_sdk/api/cloud_connectors_api.rb', line 101 def destroy_cloud_connector_with_http_info(cloud_connector_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudConnectorsApi.destroy_cloud_connector ...' end # verify the required parameter 'cloud_connector_id' is set if @api_client.config.client_side_validation && cloud_connector_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_connector_id' when calling CloudConnectorsApi.destroy_cloud_connector" end # resource path local_var_path = '/cloud_connectors/{cloud_connector_id}'.sub('{' + 'cloud_connector_id' + '}', CGI.escape(cloud_connector_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudConnectorsApi#destroy_cloud_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#index_cloud_connectors(opts = {}) ⇒ CloudConnectorCollection
Lists all cloud connectors. **API Key Scope**: cloud_connectors / index Optional API Key Explicit Scope: cloud_connectors / get_secret_key
160 161 162 163 |
# File 'lib/nodeum_sdk/api/cloud_connectors_api.rb', line 160 def index_cloud_connectors(opts = {}) data, _status_code, _headers = index_cloud_connectors_with_http_info(opts) data end |
#index_cloud_connectors_with_http_info(opts = {}) ⇒ Array<(CloudConnectorCollection, Integer, Hash)>
Lists all cloud connectors. **API Key Scope**: cloud_connectors / index Optional API Key Explicit Scope: cloud_connectors / get_secret_key
179 180 181 182 183 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 |
# File 'lib/nodeum_sdk/api/cloud_connectors_api.rb', line 179 def index_cloud_connectors_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudConnectorsApi.index_cloud_connectors ...' end # resource path local_var_path = '/cloud_connectors' # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'sort_by'] = @api_client.build_collection_param(opts[:'sort_by'], :pipe) if !opts[:'sort_by'].nil? query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'url'] = opts[:'url'] if !opts[:'url'].nil? query_params[:'url_proxy'] = opts[:'url_proxy'] if !opts[:'url_proxy'].nil? query_params[:'provider'] = opts[:'provider'] if !opts[:'provider'].nil? query_params[:'region'] = opts[:'region'] if !opts[:'region'].nil? query_params[:'access_key'] = opts[:'access_key'] if !opts[:'access_key'].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] || 'CloudConnectorCollection' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudConnectorsApi#index_cloud_connectors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#show_cloud_connector(cloud_connector_id, opts = {}) ⇒ CloudConnector
Displays a specific cloud connector. **API Key Scope**: cloud_connectors / show Optional API Key Explicit Scope: cloud_connectors / get_secret_key
237 238 239 240 |
# File 'lib/nodeum_sdk/api/cloud_connectors_api.rb', line 237 def show_cloud_connector(cloud_connector_id, opts = {}) data, _status_code, _headers = show_cloud_connector_with_http_info(cloud_connector_id, opts) data end |
#show_cloud_connector_with_http_info(cloud_connector_id, opts = {}) ⇒ Array<(CloudConnector, Integer, Hash)>
Displays a specific cloud connector. **API Key Scope**: cloud_connectors / show Optional API Key Explicit Scope: cloud_connectors / get_secret_key
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/nodeum_sdk/api/cloud_connectors_api.rb', line 247 def show_cloud_connector_with_http_info(cloud_connector_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudConnectorsApi.show_cloud_connector ...' end # verify the required parameter 'cloud_connector_id' is set if @api_client.config.client_side_validation && cloud_connector_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_connector_id' when calling CloudConnectorsApi.show_cloud_connector" end # resource path local_var_path = '/cloud_connectors/{cloud_connector_id}'.sub('{' + 'cloud_connector_id' + '}', CGI.escape(cloud_connector_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] || 'CloudConnector' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudConnectorsApi#show_cloud_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#test_cloud_connector(cloud_connector_body, opts = {}) ⇒ ActiveJobStatus
Test an unsaved cloud connector. **API Key Scope**: cloud_connectors / test
299 300 301 302 |
# File 'lib/nodeum_sdk/api/cloud_connectors_api.rb', line 299 def test_cloud_connector(cloud_connector_body, opts = {}) data, _status_code, _headers = test_cloud_connector_with_http_info(cloud_connector_body, opts) data end |
#test_cloud_connector_with_http_info(cloud_connector_body, opts = {}) ⇒ Array<(ActiveJobStatus, Integer, Hash)>
Test an unsaved cloud connector. **API Key Scope**: cloud_connectors / test
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 |
# File 'lib/nodeum_sdk/api/cloud_connectors_api.rb', line 309 def test_cloud_connector_with_http_info(cloud_connector_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudConnectorsApi.test_cloud_connector ...' end # verify the required parameter 'cloud_connector_body' is set if @api_client.config.client_side_validation && cloud_connector_body.nil? fail ArgumentError, "Missing the required parameter 'cloud_connector_body' when calling CloudConnectorsApi.test_cloud_connector" end # resource path local_var_path = '/cloud_connectors/-/test' # 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', 'queued', 'working', 'failed']) # 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(cloud_connector_body) # return_type return_type = opts[:return_type] || 'ActiveJobStatus' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] = 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(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudConnectorsApi#test_cloud_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#test_result_cloud_connector(job_id, opts = {}) ⇒ CloudBucketSimpleCollection
Check result of cloud connector test job. **API Key Scope**: cloud_connectors / test
363 364 365 366 |
# File 'lib/nodeum_sdk/api/cloud_connectors_api.rb', line 363 def test_result_cloud_connector(job_id, opts = {}) data, _status_code, _headers = test_result_cloud_connector_with_http_info(job_id, opts) data end |
#test_result_cloud_connector_with_http_info(job_id, opts = {}) ⇒ Array<(CloudBucketSimpleCollection, Integer, Hash)>
Check result of cloud connector test job. **API Key Scope**: cloud_connectors / test
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 |
# File 'lib/nodeum_sdk/api/cloud_connectors_api.rb', line 373 def test_result_cloud_connector_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudConnectorsApi.test_result_cloud_connector ...' end # verify the required parameter 'job_id' is set if @api_client.config.client_side_validation && job_id.nil? fail ArgumentError, "Missing the required parameter 'job_id' when calling CloudConnectorsApi.test_result_cloud_connector" end # resource path local_var_path = '/cloud_connectors/-/test' # query parameters query_params = opts[:query_params] || {} query_params[:'job_id'] = job_id # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'queued', 'working', 'failed', ]) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CloudBucketSimpleCollection' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudConnectorsApi#test_result_cloud_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_cloud_connector(cloud_connector_id, cloud_connector_body, opts = {}) ⇒ CloudConnector
Updates a specific cloud connector. **API Key Scope**: cloud_connectors / update
427 428 429 430 |
# File 'lib/nodeum_sdk/api/cloud_connectors_api.rb', line 427 def update_cloud_connector(cloud_connector_id, cloud_connector_body, opts = {}) data, _status_code, _headers = update_cloud_connector_with_http_info(cloud_connector_id, cloud_connector_body, opts) data end |
#update_cloud_connector_with_http_info(cloud_connector_id, cloud_connector_body, opts = {}) ⇒ Array<(CloudConnector, Integer, Hash)>
Updates a specific cloud connector. **API Key Scope**: cloud_connectors / update
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 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 |
# File 'lib/nodeum_sdk/api/cloud_connectors_api.rb', line 438 def update_cloud_connector_with_http_info(cloud_connector_id, cloud_connector_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudConnectorsApi.update_cloud_connector ...' end # verify the required parameter 'cloud_connector_id' is set if @api_client.config.client_side_validation && cloud_connector_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_connector_id' when calling CloudConnectorsApi.update_cloud_connector" end # verify the required parameter 'cloud_connector_body' is set if @api_client.config.client_side_validation && cloud_connector_body.nil? fail ArgumentError, "Missing the required parameter 'cloud_connector_body' when calling CloudConnectorsApi.update_cloud_connector" end # resource path local_var_path = '/cloud_connectors/{cloud_connector_id}'.sub('{' + 'cloud_connector_id' + '}', CGI.escape(cloud_connector_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(cloud_connector_body) # return_type return_type = opts[:return_type] || 'CloudConnector' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] = 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(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudConnectorsApi#update_cloud_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |