Class: Nodeum::CloudBucketsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CloudBucketsApi

Returns a new instance of CloudBucketsApi.



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

def api_client
  @api_client
end

Instance Method Details

#index_cloud_buckets(opts = {}) ⇒ CloudBucketCollection

Lists all cloud buckets. **API Key Scope**: cloud_buckets / 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

  • :cloud_connector_id (String) —

    Filter on cloud connector id

  • :pool_id (String) —

    Filter on a pool id

  • :name (String) —

    Filter on name

  • :location (String) —

    Filter on location

  • :price (String) —

    Filter on price

Returns:



35
36
37
38
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 35

def index_cloud_buckets(opts = {})
  data, _status_code, _headers = index_cloud_buckets_with_http_info(opts)
  data
end

#index_cloud_buckets_by_cloud_connector(cloud_connector_id, opts = {}) ⇒ CloudBucketCollection

Lists all cloud buckets. **API Key Scope**: cloud_buckets / index

Parameters:

  • cloud_connector_id (String) —

    Numeric ID or name of cloud connector.

  • 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

  • :pool_id (String) —

    Filter on a pool id

  • :name (String) —

    Filter on name

  • :location (String) —

    Filter on location

  • :price (String) —

    Filter on price

Returns:



118
119
120
121
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 118

def index_cloud_buckets_by_cloud_connector(cloud_connector_id, opts = {})
  data, _status_code, _headers = index_cloud_buckets_by_cloud_connector_with_http_info(cloud_connector_id, opts)
  data
end

#index_cloud_buckets_by_cloud_connector_with_http_info(cloud_connector_id, opts = {}) ⇒ Array<(CloudBucketCollection, Integer, Hash)>

Lists all cloud buckets. **API Key Scope**: cloud_buckets / index

Parameters:

  • cloud_connector_id (String) —

    Numeric ID or name of cloud connector.

  • 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

  • :pool_id (String) —

    Filter on a pool id

  • :name (String) —

    Filter on name

  • :location (String) —

    Filter on location

  • :price (String) —

    Filter on price

Returns:

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

    CloudBucketCollection data, response status code and response headers



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
181
182
183
184
185
186
187
188
189
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 136

def index_cloud_buckets_by_cloud_connector_with_http_info(cloud_connector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudBucketsApi.index_cloud_buckets_by_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 CloudBucketsApi.index_cloud_buckets_by_cloud_connector"
  end
  # resource path
  local_var_path = '/cloud_connectors/{cloud_connector_id}/cloud_buckets'.sub('{' + 'cloud_connector_id' + '}', CGI.escape(cloud_connector_id.to_s))

  # 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[:'pool_id'] = opts[:'pool_id'] if !opts[:'pool_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'location'] = opts[:'location'] if !opts[:'location'].nil?
  query_params[:'price'] = opts[:'price'] if !opts[:'price'].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] || 'CloudBucketCollection' 

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

#index_cloud_buckets_by_pool(pool_id, opts = {}) ⇒ CloudBucketCollection

Lists all cloud buckets from pool. **API Key Scope**: cloud_buckets / index

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • 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

  • :cloud_connector_id (String) —

    Filter on cloud connector id

  • :name (String) —

    Filter on name

  • :location (String) —

    Filter on location

  • :price (String) —

    Filter on price

Returns:



204
205
206
207
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 204

def index_cloud_buckets_by_pool(pool_id, opts = {})
  data, _status_code, _headers = index_cloud_buckets_by_pool_with_http_info(pool_id, opts)
  data
end

#index_cloud_buckets_by_pool_with_http_info(pool_id, opts = {}) ⇒ Array<(CloudBucketCollection, Integer, Hash)>

Lists all cloud buckets from pool. **API Key Scope**: cloud_buckets / index

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • 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

  • :cloud_connector_id (String) —

    Filter on cloud connector id

  • :name (String) —

    Filter on name

  • :location (String) —

    Filter on location

  • :price (String) —

    Filter on price

Returns:

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

    CloudBucketCollection data, response status code and response headers



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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 222

def index_cloud_buckets_by_pool_with_http_info(pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudBucketsApi.index_cloud_buckets_by_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 CloudBucketsApi.index_cloud_buckets_by_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/cloud_buckets'.sub('{' + 'pool_id' + '}', CGI.escape(pool_id.to_s))

  # 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[:'cloud_connector_id'] = opts[:'cloud_connector_id'] if !opts[:'cloud_connector_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'location'] = opts[:'location'] if !opts[:'location'].nil?
  query_params[:'price'] = opts[:'price'] if !opts[:'price'].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] || 'CloudBucketCollection' 

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

#index_cloud_buckets_with_http_info(opts = {}) ⇒ Array<(CloudBucketCollection, Integer, Hash)>

Lists all cloud buckets. **API Key Scope**: cloud_buckets / 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

  • :cloud_connector_id (String) —

    Filter on cloud connector id

  • :pool_id (String) —

    Filter on a pool id

  • :name (String) —

    Filter on name

  • :location (String) —

    Filter on location

  • :price (String) —

    Filter on price

Returns:

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

    CloudBucketCollection data, response status code and response headers



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
101
102
103
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 53

def index_cloud_buckets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudBucketsApi.index_cloud_buckets ...'
  end
  # resource path
  local_var_path = '/cloud_buckets'

  # 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[:'cloud_connector_id'] = opts[:'cloud_connector_id'] if !opts[:'cloud_connector_id'].nil?
  query_params[:'pool_id'] = opts[:'pool_id'] if !opts[:'pool_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'location'] = opts[:'location'] if !opts[:'location'].nil?
  query_params[:'price'] = opts[:'price'] if !opts[:'price'].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] || 'CloudBucketCollection' 

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

#mount_status_cloud_bucket(cloud_bucket_id, opts = {}) ⇒ MountStatus

Get mount status of Cloud bucket. **API Key Scope**: cloud_buckets / mount_status

Parameters:

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:



282
283
284
285
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 282

def mount_status_cloud_bucket(cloud_bucket_id, opts = {})
  data, _status_code, _headers = mount_status_cloud_bucket_with_http_info(cloud_bucket_id, opts)
  data
end

#mount_status_cloud_bucket_by_cloud_connector(cloud_connector_id, cloud_bucket_id, opts = {}) ⇒ MountStatus

Get mount status of Cloud bucket. **API Key Scope**: cloud_buckets / mount_status

Parameters:

  • cloud_connector_id (String) —

    Numeric ID or name of cloud connector.

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:



345
346
347
348
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 345

def mount_status_cloud_bucket_by_cloud_connector(cloud_connector_id, cloud_bucket_id, opts = {})
  data, _status_code, _headers = mount_status_cloud_bucket_by_cloud_connector_with_http_info(cloud_connector_id, cloud_bucket_id, opts)
  data
end

#mount_status_cloud_bucket_by_cloud_connector_with_http_info(cloud_connector_id, cloud_bucket_id, opts = {}) ⇒ Array<(MountStatus, Integer, Hash)>

Get mount status of Cloud bucket. **API Key Scope**: cloud_buckets / mount_status

Parameters:

  • cloud_connector_id (String) —

    Numeric ID or name of cloud connector.

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:

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

    MountStatus data, response status code and response headers



356
357
358
359
360
361
362
363
364
365
366
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
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 356

def mount_status_cloud_bucket_by_cloud_connector_with_http_info(cloud_connector_id, cloud_bucket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudBucketsApi.mount_status_cloud_bucket_by_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 CloudBucketsApi.mount_status_cloud_bucket_by_cloud_connector"
  end
  # verify the required parameter 'cloud_bucket_id' is set
  if @api_client.config.client_side_validation && cloud_bucket_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.mount_status_cloud_bucket_by_cloud_connector"
  end
  # resource path
  local_var_path = '/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}/mount'.sub('{' + 'cloud_connector_id' + '}', CGI.escape(cloud_connector_id.to_s)).sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_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: CloudBucketsApi#mount_status_cloud_bucket_by_cloud_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mount_status_cloud_bucket_by_pool(pool_id, cloud_bucket_id, opts = {}) ⇒ MountStatus

Get mount status of Cloud bucket. **API Key Scope**: cloud_buckets / mount_status

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:



413
414
415
416
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 413

def mount_status_cloud_bucket_by_pool(pool_id, cloud_bucket_id, opts = {})
  data, _status_code, _headers = mount_status_cloud_bucket_by_pool_with_http_info(pool_id, cloud_bucket_id, opts)
  data
end

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

Get mount status of Cloud bucket. **API Key Scope**: cloud_buckets / mount_status

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:

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

    MountStatus data, response status code and response headers



424
425
426
427
428
429
430
431
432
433
434
435
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
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 424

def mount_status_cloud_bucket_by_pool_with_http_info(pool_id, cloud_bucket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudBucketsApi.mount_status_cloud_bucket_by_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 CloudBucketsApi.mount_status_cloud_bucket_by_pool"
  end
  # verify the required parameter 'cloud_bucket_id' is set
  if @api_client.config.client_side_validation && cloud_bucket_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.mount_status_cloud_bucket_by_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/cloud_buckets/{cloud_bucket_id}/mount'.sub('{' + 'pool_id' + '}', CGI.escape(pool_id.to_s)).sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_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: CloudBucketsApi#mount_status_cloud_bucket_by_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mount_status_cloud_bucket_with_http_info(cloud_bucket_id, opts = {}) ⇒ Array<(MountStatus, Integer, Hash)>

Get mount status of Cloud bucket. **API Key Scope**: cloud_buckets / mount_status

Parameters:

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:

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

    MountStatus data, response status code and response headers



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
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 292

def mount_status_cloud_bucket_with_http_info(cloud_bucket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudBucketsApi.mount_status_cloud_bucket ...'
  end
  # verify the required parameter 'cloud_bucket_id' is set
  if @api_client.config.client_side_validation && cloud_bucket_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.mount_status_cloud_bucket"
  end
  # resource path
  local_var_path = '/cloud_buckets/{cloud_bucket_id}/mount'.sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_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: CloudBucketsApi#mount_status_cloud_bucket\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#show_cloud_bucket(cloud_bucket_id, opts = {}) ⇒ CloudBucket

Displays a specific cloud bucket. **API Key Scope**: cloud_buckets / show

Parameters:

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:



480
481
482
483
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 480

def show_cloud_bucket(cloud_bucket_id, opts = {})
  data, _status_code, _headers = show_cloud_bucket_with_http_info(cloud_bucket_id, opts)
  data
end

#show_cloud_bucket_by_cloud_connector(cloud_connector_id, cloud_bucket_id, opts = {}) ⇒ CloudBucket

Displays a specific cloud bucket. **API Key Scope**: cloud_buckets / show

Parameters:

  • cloud_connector_id (String) —

    Numeric ID or name of cloud connector.

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:



543
544
545
546
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 543

def show_cloud_bucket_by_cloud_connector(cloud_connector_id, cloud_bucket_id, opts = {})
  data, _status_code, _headers = show_cloud_bucket_by_cloud_connector_with_http_info(cloud_connector_id, cloud_bucket_id, opts)
  data
end

#show_cloud_bucket_by_cloud_connector_with_http_info(cloud_connector_id, cloud_bucket_id, opts = {}) ⇒ Array<(CloudBucket, Integer, Hash)>

Displays a specific cloud bucket. **API Key Scope**: cloud_buckets / show

Parameters:

  • cloud_connector_id (String) —

    Numeric ID or name of cloud connector.

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:

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

    CloudBucket data, response status code and response headers



554
555
556
557
558
559
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
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 554

def show_cloud_bucket_by_cloud_connector_with_http_info(cloud_connector_id, cloud_bucket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudBucketsApi.show_cloud_bucket_by_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 CloudBucketsApi.show_cloud_bucket_by_cloud_connector"
  end
  # verify the required parameter 'cloud_bucket_id' is set
  if @api_client.config.client_side_validation && cloud_bucket_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.show_cloud_bucket_by_cloud_connector"
  end
  # resource path
  local_var_path = '/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}'.sub('{' + 'cloud_connector_id' + '}', CGI.escape(cloud_connector_id.to_s)).sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_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] || 'CloudBucket' 

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

#show_cloud_bucket_by_pool(pool_id, cloud_bucket_id, opts = {}) ⇒ CloudBucket

Displays a specific cloud bucket. **API Key Scope**: cloud_buckets / show

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:



611
612
613
614
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 611

def show_cloud_bucket_by_pool(pool_id, cloud_bucket_id, opts = {})
  data, _status_code, _headers = show_cloud_bucket_by_pool_with_http_info(pool_id, cloud_bucket_id, opts)
  data
end

#show_cloud_bucket_by_pool_with_http_info(pool_id, cloud_bucket_id, opts = {}) ⇒ Array<(CloudBucket, Integer, Hash)>

Displays a specific cloud bucket. **API Key Scope**: cloud_buckets / show

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:

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

    CloudBucket data, response status code and response headers



622
623
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
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 622

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

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

#show_cloud_bucket_with_http_info(cloud_bucket_id, opts = {}) ⇒ Array<(CloudBucket, Integer, Hash)>

Displays a specific cloud bucket. **API Key Scope**: cloud_buckets / show

Parameters:

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:

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

    CloudBucket data, response status code and response headers



490
491
492
493
494
495
496
497
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
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 490

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

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

#sync_cloud_buckets(cloud_connector_id, opts = {}) ⇒ ActiveJobStatus

Synchronize internal cloud buckets with their remote equivalent. **API Key Scope**: cloud_buckets / sync

Parameters:

  • cloud_connector_id (String) —

    Numeric ID or name of cloud connector.

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

    the optional parameters

Returns:



678
679
680
681
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 678

def sync_cloud_buckets(cloud_connector_id, opts = {})
  data, _status_code, _headers = sync_cloud_buckets_with_http_info(cloud_connector_id, opts)
  data
end

#sync_cloud_buckets_with_http_info(cloud_connector_id, opts = {}) ⇒ Array<(ActiveJobStatus, Integer, Hash)>

Synchronize internal cloud buckets with their remote equivalent. **API Key Scope**: cloud_buckets / sync

Parameters:

  • cloud_connector_id (String) —

    Numeric ID or name of cloud connector.

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

    the optional parameters

Returns:

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

    ActiveJobStatus data, response status code and response headers



688
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
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 688

def sync_cloud_buckets_with_http_info(cloud_connector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudBucketsApi.sync_cloud_buckets ...'
  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 CloudBucketsApi.sync_cloud_buckets"
  end
  # resource path
  local_var_path = '/cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync'.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', 'queued', 'working', 'failed'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

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

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

#sync_result_cloud_buckets(cloud_connector_id, job_id, opts = {}) ⇒ CloudBucketSimpleCollection

Check result of cloud connector sync job. **API Key Scope**: cloud_buckets / sync

Parameters:

  • cloud_connector_id (String) —

    Numeric ID or name of cloud connector.

  • job_id (String) —

    ID of active job

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

    the optional parameters

Returns:



741
742
743
744
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 741

def sync_result_cloud_buckets(cloud_connector_id, job_id, opts = {})
  data, _status_code, _headers = sync_result_cloud_buckets_with_http_info(cloud_connector_id, job_id, opts)
  data
end

#sync_result_cloud_buckets_with_http_info(cloud_connector_id, job_id, opts = {}) ⇒ Array<(CloudBucketSimpleCollection, Integer, Hash)>

Check result of cloud connector sync job. **API Key Scope**: cloud_buckets / sync

Parameters:

  • cloud_connector_id (String) —

    Numeric ID or name of cloud connector.

  • job_id (String) —

    ID of active job

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

    the optional parameters

Returns:

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

    CloudBucketSimpleCollection data, response status code and response headers



752
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
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 752

def sync_result_cloud_buckets_with_http_info(cloud_connector_id, job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudBucketsApi.sync_result_cloud_buckets ...'
  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 CloudBucketsApi.sync_result_cloud_buckets"
  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 CloudBucketsApi.sync_result_cloud_buckets"
  end
  # resource path
  local_var_path = '/cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync'.sub('{' + 'cloud_connector_id' + '}', CGI.escape(cloud_connector_id.to_s))

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

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

#update_cloud_bucket(cloud_bucket_id, cloud_bucket_body, opts = {}) ⇒ CloudBucket

Updates a specific cloud bucket. **API Key Scope**: cloud_buckets / update

Parameters:

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:



810
811
812
813
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 810

def update_cloud_bucket(cloud_bucket_id, cloud_bucket_body, opts = {})
  data, _status_code, _headers = update_cloud_bucket_with_http_info(cloud_bucket_id, cloud_bucket_body, opts)
  data
end

#update_cloud_bucket_by_cloud_connector(cloud_connector_id, cloud_bucket_id, cloud_bucket_body, opts = {}) ⇒ CloudBucket

Updates a specific cloud bucket. **API Key Scope**: cloud_buckets / update

Parameters:

  • cloud_connector_id (String) —

    Numeric ID or name of cloud connector.

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:



881
882
883
884
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 881

def update_cloud_bucket_by_cloud_connector(cloud_connector_id, cloud_bucket_id, cloud_bucket_body, opts = {})
  data, _status_code, _headers = update_cloud_bucket_by_cloud_connector_with_http_info(cloud_connector_id, cloud_bucket_id, cloud_bucket_body, opts)
  data
end

#update_cloud_bucket_by_cloud_connector_with_http_info(cloud_connector_id, cloud_bucket_id, cloud_bucket_body, opts = {}) ⇒ Array<(CloudBucket, Integer, Hash)>

Updates a specific cloud bucket. **API Key Scope**: cloud_buckets / update

Parameters:

  • cloud_connector_id (String) —

    Numeric ID or name of cloud connector.

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:

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

    CloudBucket data, response status code and response headers



893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 893

def update_cloud_bucket_by_cloud_connector_with_http_info(cloud_connector_id, cloud_bucket_id, cloud_bucket_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudBucketsApi.update_cloud_bucket_by_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 CloudBucketsApi.update_cloud_bucket_by_cloud_connector"
  end
  # verify the required parameter 'cloud_bucket_id' is set
  if @api_client.config.client_side_validation && cloud_bucket_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.update_cloud_bucket_by_cloud_connector"
  end
  # verify the required parameter 'cloud_bucket_body' is set
  if @api_client.config.client_side_validation && cloud_bucket_body.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_bucket_body' when calling CloudBucketsApi.update_cloud_bucket_by_cloud_connector"
  end
  # resource path
  local_var_path = '/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}'.sub('{' + 'cloud_connector_id' + '}', CGI.escape(cloud_connector_id.to_s)).sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_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_bucket_body) 

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

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

#update_cloud_bucket_by_pool(pool_id, cloud_bucket_id, cloud_bucket_body, opts = {}) ⇒ CloudBucket

Updates a specific cloud bucket. **API Key Scope**: cloud_buckets / update

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:



957
958
959
960
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 957

def update_cloud_bucket_by_pool(pool_id, cloud_bucket_id, cloud_bucket_body, opts = {})
  data, _status_code, _headers = update_cloud_bucket_by_pool_with_http_info(pool_id, cloud_bucket_id, cloud_bucket_body, opts)
  data
end

#update_cloud_bucket_by_pool_with_http_info(pool_id, cloud_bucket_id, cloud_bucket_body, opts = {}) ⇒ Array<(CloudBucket, Integer, Hash)>

Updates a specific cloud bucket. **API Key Scope**: cloud_buckets / update

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:

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

    CloudBucket data, response status code and response headers



969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 969

def update_cloud_bucket_by_pool_with_http_info(pool_id, cloud_bucket_id, cloud_bucket_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudBucketsApi.update_cloud_bucket_by_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 CloudBucketsApi.update_cloud_bucket_by_pool"
  end
  # verify the required parameter 'cloud_bucket_id' is set
  if @api_client.config.client_side_validation && cloud_bucket_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.update_cloud_bucket_by_pool"
  end
  # verify the required parameter 'cloud_bucket_body' is set
  if @api_client.config.client_side_validation && cloud_bucket_body.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_bucket_body' when calling CloudBucketsApi.update_cloud_bucket_by_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/cloud_buckets/{cloud_bucket_id}'.sub('{' + 'pool_id' + '}', CGI.escape(pool_id.to_s)).sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_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_bucket_body) 

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

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

#update_cloud_bucket_with_http_info(cloud_bucket_id, cloud_bucket_body, opts = {}) ⇒ Array<(CloudBucket, Integer, Hash)>

Updates a specific cloud bucket. **API Key Scope**: cloud_buckets / update

Parameters:

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

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

    the optional parameters

Returns:

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

    CloudBucket data, response status code and response headers



821
822
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
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 821

def update_cloud_bucket_with_http_info(cloud_bucket_id, cloud_bucket_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudBucketsApi.update_cloud_bucket ...'
  end
  # verify the required parameter 'cloud_bucket_id' is set
  if @api_client.config.client_side_validation && cloud_bucket_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.update_cloud_bucket"
  end
  # verify the required parameter 'cloud_bucket_body' is set
  if @api_client.config.client_side_validation && cloud_bucket_body.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_bucket_body' when calling CloudBucketsApi.update_cloud_bucket"
  end
  # resource path
  local_var_path = '/cloud_buckets/{cloud_bucket_id}'.sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_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_bucket_body) 

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

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

#update_config_file_cloud_bucket(cloud_bucket_id, config_file, opts = {}) ⇒ String

Updates a specific cloud bucket. **API Key Scope**: cloud_buckets / update_config_file

Parameters:

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

  • config_file (File) —

    Config file to upload.

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

    the optional parameters

Returns:

  • (String) 


1032
1033
1034
1035
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 1032

def update_config_file_cloud_bucket(cloud_bucket_id, config_file, opts = {})
  data, _status_code, _headers = update_config_file_cloud_bucket_with_http_info(cloud_bucket_id, config_file, opts)
  data
end

#update_config_file_cloud_bucket_with_http_info(cloud_bucket_id, config_file, opts = {}) ⇒ Array<(String, Integer, Hash)>

Updates a specific cloud bucket. **API Key Scope**: cloud_buckets / update_config_file

Parameters:

  • cloud_bucket_id (String) —

    Numeric ID or name of cloud bucket.

  • config_file (File) —

    Config file to upload.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
 
# File 'lib/nodeum_sdk/api/cloud_buckets_api.rb', line 1043

def update_config_file_cloud_bucket_with_http_info(cloud_bucket_id, config_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudBucketsApi.update_config_file_cloud_bucket ...'
  end
  # verify the required parameter 'cloud_bucket_id' is set
  if @api_client.config.client_side_validation && cloud_bucket_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.update_config_file_cloud_bucket"
  end
  # verify the required parameter 'config_file' is set
  if @api_client.config.client_side_validation && config_file.nil?
    fail ArgumentError, "Missing the required parameter 'config_file' when calling CloudBucketsApi.update_config_file_cloud_bucket"
  end
  # resource path
  local_var_path = '/cloud_buckets/{cloud_bucket_id}/config_file'.sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_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(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['config_file'] = config_file

  # http body (model)
  post_body = opts[:body] 

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

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