Class: Nodeum::PoolsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/nodeum_sdk/api/pools_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PoolsApi

Returns a new instance of PoolsApi.



19
20
21
 
# File 'lib/nodeum_sdk/api/pools_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/pools_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_pool(pool_body, opts = {}) ⇒ Pool

Creates a new pool. **API Key Scope**: pools / create

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 27

def create_pool(pool_body, opts = {})
  data, _status_code, _headers = create_pool_with_http_info(pool_body, opts)
  data
end

#create_pool_with_http_info(pool_body, opts = {}) ⇒ Array<(Pool, Integer, Hash)>

Creates a new pool. **API Key Scope**: pools / create

Parameters:

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

    the optional parameters

Returns:

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

    Pool 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
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 37

def create_pool_with_http_info(pool_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoolsApi.create_pool ...'
  end
  # verify the required parameter 'pool_body' is set
  if @api_client.config.client_side_validation && pool_body.nil?
    fail ArgumentError, "Missing the required parameter 'pool_body' when calling PoolsApi.create_pool"
  end
  # resource path
  local_var_path = '/pools'

  # 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(pool_body) 

  # return_type
  return_type = opts[:return_type] || 'Pool' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  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: PoolsApi#create_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_primary_scan(pool_id, primary_scan_body, opts = {}) ⇒ PrimaryScan

Set a new primary pool scan option. **API Key Scope**: primary_scans / create

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:



92
93
94
95
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 92

def create_primary_scan(pool_id, primary_scan_body, opts = {})
  data, _status_code, _headers = create_primary_scan_with_http_info(pool_id, primary_scan_body, opts)
  data
end

#create_primary_scan_with_http_info(pool_id, primary_scan_body, opts = {}) ⇒ Array<(PrimaryScan, Integer, Hash)>

Set a new primary pool scan option. **API Key Scope**: primary_scans / create

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:

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

    PrimaryScan data, response status code and response headers



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
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 103

def create_primary_scan_with_http_info(pool_id, primary_scan_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoolsApi.create_primary_scan ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling PoolsApi.create_primary_scan"
  end
  # verify the required parameter 'primary_scan_body' is set
  if @api_client.config.client_side_validation && primary_scan_body.nil?
    fail ArgumentError, "Missing the required parameter 'primary_scan_body' when calling PoolsApi.create_primary_scan"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/primary_scan'.sub('{' + 'pool_id' + '}', CGI.escape(pool_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(primary_scan_body) 

  # return_type
  return_type = opts[:return_type] || 'PrimaryScan' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  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: PoolsApi#create_primary_scan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#destroy_pool(pool_id, opts = {}) ⇒ nil

Destroys a specific tape pool. **API Key Scope**: pools / destroy

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:

  • (nil) 


161
162
163
164
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 161

def destroy_pool(pool_id, opts = {})
  destroy_pool_with_http_info(pool_id, opts)
  nil
end

#destroy_pool_with_http_info(pool_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Destroys a specific tape pool. **API Key Scope**: pools / destroy

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



171
172
173
174
175
176
177
178
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
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 171

def destroy_pool_with_http_info(pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoolsApi.destroy_pool ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling PoolsApi.destroy_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}'.sub('{' + 'pool_id' + '}', CGI.escape(pool_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']

  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: PoolsApi#destroy_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#destroy_primary_scan(pool_id, opts = {}) ⇒ nil

Disable the primary pool scan. **API Key Scope**: primary_scans / destroy

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:

  • (nil) 


221
222
223
224
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 221

def destroy_primary_scan(pool_id, opts = {})
  destroy_primary_scan_with_http_info(pool_id, opts)
  nil
end

#destroy_primary_scan_with_http_info(pool_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Disable the primary pool scan. **API Key Scope**: primary_scans / destroy

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
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
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 231

def destroy_primary_scan_with_http_info(pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoolsApi.destroy_primary_scan ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling PoolsApi.destroy_primary_scan"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/primary_scan'.sub('{' + 'pool_id' + '}', CGI.escape(pool_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']

  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: PoolsApi#destroy_primary_scan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#index_pools(opts = {}) ⇒ PoolCollection

Lists all pools. **API Key Scope**: pools / index

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of items to display for pagination.

  • :offset (Integer) —

    The number of items to skip for pagination.

  • :sort_by (Array<String>) —

    Sort results by attribute. Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;.

  • :id (String) —

    Filter on id

  • :name (String) —

    Filter on name

  • :comment (String) —

    Filter on comment

  • :type (String) —

    Filter on type

  • :content (String) —

    Filter on content

  • :primary_id (String) —

    Filter on primary id

Returns:



289
290
291
292
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 289

def index_pools(opts = {})
  data, _status_code, _headers = index_pools_with_http_info(opts)
  data
end

#index_pools_with_http_info(opts = {}) ⇒ Array<(PoolCollection, Integer, Hash)>

Lists all pools. **API Key Scope**: pools / index

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of items to display for pagination.

  • :offset (Integer) —

    The number of items to skip for pagination.

  • :sort_by (Array<String>) —

    Sort results by attribute. Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;.

  • :id (String) —

    Filter on id

  • :name (String) —

    Filter on name

  • :comment (String) —

    Filter on comment

  • :type (String) —

    Filter on type

  • :content (String) —

    Filter on content

  • :primary_id (String) —

    Filter on primary id

Returns:

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

    PoolCollection data, response status code and response headers



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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 307

def index_pools_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoolsApi.index_pools ...'
  end
  # resource path
  local_var_path = '/pools'

  # 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[:'comment'] = opts[:'comment'] if !opts[:'comment'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'content'] = opts[:'content'] if !opts[:'content'].nil?
  query_params[:'primary_id'] = opts[:'primary_id'] if !opts[:'primary_id'].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] || 'PoolCollection' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  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: PoolsApi#index_pools\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mount_pool(pool_id, opts = {}) ⇒ MountStatus

Mount Pool. **API Key Scope**: pools / mount

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:



364
365
366
367
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 364

def mount_pool(pool_id, opts = {})
  data, _status_code, _headers = mount_pool_with_http_info(pool_id, opts)
  data
end

#mount_pool_with_http_info(pool_id, opts = {}) ⇒ Array<(MountStatus, Integer, Hash)>

Mount Pool. **API Key Scope**: pools / mount

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:

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

    MountStatus data, response status code and response headers



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/pools_api.rb', line 374

def mount_pool_with_http_info(pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoolsApi.mount_pool ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling PoolsApi.mount_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/mount'.sub('{' + 'pool_id' + '}', CGI.escape(pool_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] || 'MountStatus' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PoolsApi#mount_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mount_status_pool(pool_id, opts = {}) ⇒ MountStatus

Get mount status of Pool. **API Key Scope**: pools / mount_status

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:



426
427
428
429
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 426

def mount_status_pool(pool_id, opts = {})
  data, _status_code, _headers = mount_status_pool_with_http_info(pool_id, opts)
  data
end

#mount_status_pool_with_http_info(pool_id, opts = {}) ⇒ Array<(MountStatus, Integer, Hash)>

Get mount status of Pool. **API Key Scope**: pools / mount_status

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:

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

    MountStatus data, response status code and response headers



436
437
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
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 436

def mount_status_pool_with_http_info(pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoolsApi.mount_status_pool ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling PoolsApi.mount_status_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/mount'.sub('{' + 'pool_id' + '}', CGI.escape(pool_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] || 'MountStatus' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  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: PoolsApi#mount_status_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#show_pool(pool_id, opts = {}) ⇒ Pool

Displays a specific pool. **API Key Scope**: pools / show

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:



488
489
490
491
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 488

def show_pool(pool_id, opts = {})
  data, _status_code, _headers = show_pool_with_http_info(pool_id, opts)
  data
end

#show_pool_with_http_info(pool_id, opts = {}) ⇒ Array<(Pool, Integer, Hash)>

Displays a specific pool. **API Key Scope**: pools / show

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:

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

    Pool data, response status code and response headers



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
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
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 498

def show_pool_with_http_info(pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoolsApi.show_pool ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling PoolsApi.show_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}'.sub('{' + 'pool_id' + '}', CGI.escape(pool_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] || 'Pool' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  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: PoolsApi#show_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#show_primary_scan(pool_id, opts = {}) ⇒ PrimaryScan

Displays the primary pool scan status. **API Key Scope**: primary_scans / show

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:



550
551
552
553
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 550

def show_primary_scan(pool_id, opts = {})
  data, _status_code, _headers = show_primary_scan_with_http_info(pool_id, opts)
  data
end

#show_primary_scan_with_http_info(pool_id, opts = {}) ⇒ Array<(PrimaryScan, Integer, Hash)>

Displays the primary pool scan status. **API Key Scope**: primary_scans / show

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:

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

    PrimaryScan data, response status code and response headers



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 560

def show_primary_scan_with_http_info(pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoolsApi.show_primary_scan ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling PoolsApi.show_primary_scan"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/primary_scan'.sub('{' + 'pool_id' + '}', CGI.escape(pool_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] || 'PrimaryScan' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  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: PoolsApi#show_primary_scan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sync_primary_pool(pool_id, tx, opts = {}) ⇒ nil

Synchronize a primary after a scan (for internal use only). **API Key Scope**: pools / sync_primary

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • tx (Integer) —

    New transaction number.

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

    the optional parameters

Returns:

  • (nil) 


613
614
615
616
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 613

def sync_primary_pool(pool_id, tx, opts = {})
  sync_primary_pool_with_http_info(pool_id, tx, opts)
  nil
end

#sync_primary_pool_with_http_info(pool_id, tx, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Synchronize a primary after a scan (for internal use only). **API Key Scope**: pools / sync_primary

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • tx (Integer) —

    New transaction number.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
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
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 624

def sync_primary_pool_with_http_info(pool_id, tx, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoolsApi.sync_primary_pool ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling PoolsApi.sync_primary_pool"
  end
  # verify the required parameter 'tx' is set
  if @api_client.config.client_side_validation && tx.nil?
    fail ArgumentError, "Missing the required parameter 'tx' when calling PoolsApi.sync_primary_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/sync'.sub('{' + 'pool_id' + '}', CGI.escape(pool_id.to_s))

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

  # 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']

  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: PoolsApi#sync_primary_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unmount_pool(pool_id, opts = {}) ⇒ MountStatus

Unmount Pool. **API Key Scope**: pools / unmount

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:



679
680
681
682
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 679

def unmount_pool(pool_id, opts = {})
  data, _status_code, _headers = unmount_pool_with_http_info(pool_id, opts)
  data
end

#unmount_pool_with_http_info(pool_id, opts = {}) ⇒ Array<(MountStatus, Integer, Hash)>

Unmount Pool. **API Key Scope**: pools / unmount

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:

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

    MountStatus data, response status code and response headers



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
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
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 689

def unmount_pool_with_http_info(pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoolsApi.unmount_pool ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling PoolsApi.unmount_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/mount'.sub('{' + 'pool_id' + '}', CGI.escape(pool_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] || 'MountStatus' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  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: PoolsApi#unmount_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_pool(pool_id, pool_body, opts = {}) ⇒ Pool

Updates a specific pool. **API Key Scope**: pools / update

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:



742
743
744
745
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 742

def update_pool(pool_id, pool_body, opts = {})
  data, _status_code, _headers = update_pool_with_http_info(pool_id, pool_body, opts)
  data
end

#update_pool_with_http_info(pool_id, pool_body, opts = {}) ⇒ Array<(Pool, Integer, Hash)>

Updates a specific pool. **API Key Scope**: pools / update

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:

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

    Pool data, response status code and response headers



753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
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
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 753

def update_pool_with_http_info(pool_id, pool_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoolsApi.update_pool ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling PoolsApi.update_pool"
  end
  # verify the required parameter 'pool_body' is set
  if @api_client.config.client_side_validation && pool_body.nil?
    fail ArgumentError, "Missing the required parameter 'pool_body' when calling PoolsApi.update_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}'.sub('{' + 'pool_id' + '}', CGI.escape(pool_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(pool_body) 

  # return_type
  return_type = opts[:return_type] || 'Pool' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PoolsApi#update_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_primary_scan(pool_id, primary_scan_body, opts = {}) ⇒ PrimaryScan

Updates the existing primary pool scan option. **API Key Scope**: primary_scans / update

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:



812
813
814
815
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 812

def update_primary_scan(pool_id, primary_scan_body, opts = {})
  data, _status_code, _headers = update_primary_scan_with_http_info(pool_id, primary_scan_body, opts)
  data
end

#update_primary_scan_with_http_info(pool_id, primary_scan_body, opts = {}) ⇒ Array<(PrimaryScan, Integer, Hash)>

Updates the existing primary pool scan option. **API Key Scope**: primary_scans / update

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

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

    the optional parameters

Returns:

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

    PrimaryScan data, response status code and response headers



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
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
 
# File 'lib/nodeum_sdk/api/pools_api.rb', line 823

def update_primary_scan_with_http_info(pool_id, primary_scan_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoolsApi.update_primary_scan ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling PoolsApi.update_primary_scan"
  end
  # verify the required parameter 'primary_scan_body' is set
  if @api_client.config.client_side_validation && primary_scan_body.nil?
    fail ArgumentError, "Missing the required parameter 'primary_scan_body' when calling PoolsApi.update_primary_scan"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/primary_scan'.sub('{' + 'pool_id' + '}', CGI.escape(pool_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(primary_scan_body) 

  # return_type
  return_type = opts[:return_type] || 'PrimaryScan' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PoolsApi#update_primary_scan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end