Class: Nodeum::FilesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FilesApi

Returns a new instance of FilesApi.



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

def api_client
  @api_client
end

Instance Method Details

#files_children(file_parent_id, opts = {}) ⇒ NodeumFileCollection

Lists files under a specific folder. **API Key Scope**: files / index

Parameters:

  • file_parent_id (Integer) —

    Numeric ID of parent folder.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:



39
40
41
42
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 39

def files_children(file_parent_id, opts = {})
  data, _status_code, _headers = files_children_with_http_info(file_parent_id, opts)
  data
end

#files_children_by_container(container_id, file_parent_id, opts = {}) ⇒ NodeumFileCollection

Lists files under a specific folder. **API Key Scope**: files / index

Parameters:

  • container_id (String) —

    Numeric ID or name of container.

  • file_parent_id (Integer) —

    Numeric ID of parent folder.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:



138
139
140
141
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 138

def files_children_by_container(container_id, file_parent_id, opts = {})
  data, _status_code, _headers = files_children_by_container_with_http_info(container_id, file_parent_id, opts)
  data
end

#files_children_by_container_with_http_info(container_id, file_parent_id, opts = {}) ⇒ Array<(NodeumFileCollection, Integer, Hash)>

Lists files under a specific folder. **API Key Scope**: files / index

Parameters:

  • container_id (String) —

    Numeric ID or name of container.

  • file_parent_id (Integer) —

    Numeric ID of parent folder.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:

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

    NodeumFileCollection data, response status code and response headers



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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 161

def files_children_by_container_with_http_info(container_id, file_parent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.files_children_by_container ...'
  end
  # verify the required parameter 'container_id' is set
  if @api_client.config.client_side_validation && container_id.nil?
    fail ArgumentError, "Missing the required parameter 'container_id' when calling FilesApi.files_children_by_container"
  end
  # verify the required parameter 'file_parent_id' is set
  if @api_client.config.client_side_validation && file_parent_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_parent_id' when calling FilesApi.files_children_by_container"
  end
  # resource path
  local_var_path = '/containers/{container_id}/files/{file_parent_id}/children'.sub('{' + 'container_id' + '}', CGI.escape(container_id.to_s)).sub('{' + 'file_parent_id' + '}', CGI.escape(file_parent_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[:'file_id'] = opts[:'file_id'] if !opts[:'file_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'permission'] = opts[:'permission'] if !opts[:'permission'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'change_date'] = opts[:'change_date'] if !opts[:'change_date'].nil?
  query_params[:'modification_date'] = opts[:'modification_date'] if !opts[:'modification_date'].nil?
  query_params[:'access_date'] = opts[:'access_date'] if !opts[:'access_date'].nil?
  query_params[:'gid'] = opts[:'gid'] if !opts[:'gid'].nil?
  query_params[:'uid'] = opts[:'uid'] if !opts[:'uid'].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] || 'NodeumFileCollection' 

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

#files_children_by_pool(pool_id, file_parent_id, opts = {}) ⇒ NodeumFileCollection

Lists files under a specific folder. **API Key Scope**: files / index

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • file_parent_id (Integer) —

    Numeric ID of parent folder.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:



242
243
244
245
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 242

def files_children_by_pool(pool_id, file_parent_id, opts = {})
  data, _status_code, _headers = files_children_by_pool_with_http_info(pool_id, file_parent_id, opts)
  data
end

#files_children_by_pool_with_http_info(pool_id, file_parent_id, opts = {}) ⇒ Array<(NodeumFileCollection, Integer, Hash)>

Lists files under a specific folder. **API Key Scope**: files / index

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • file_parent_id (Integer) —

    Numeric ID of parent folder.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:

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

    NodeumFileCollection data, response status code and response headers



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
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
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 265

def files_children_by_pool_with_http_info(pool_id, file_parent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.files_children_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 FilesApi.files_children_by_pool"
  end
  # verify the required parameter 'file_parent_id' is set
  if @api_client.config.client_side_validation && file_parent_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_parent_id' when calling FilesApi.files_children_by_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/files/{file_parent_id}/children'.sub('{' + 'pool_id' + '}', CGI.escape(pool_id.to_s)).sub('{' + 'file_parent_id' + '}', CGI.escape(file_parent_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[:'file_id'] = opts[:'file_id'] if !opts[:'file_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'permission'] = opts[:'permission'] if !opts[:'permission'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'change_date'] = opts[:'change_date'] if !opts[:'change_date'].nil?
  query_params[:'modification_date'] = opts[:'modification_date'] if !opts[:'modification_date'].nil?
  query_params[:'access_date'] = opts[:'access_date'] if !opts[:'access_date'].nil?
  query_params[:'gid'] = opts[:'gid'] if !opts[:'gid'].nil?
  query_params[:'uid'] = opts[:'uid'] if !opts[:'uid'].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] || 'NodeumFileCollection' 

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

#files_children_by_task(task_id, file_parent_id, opts = {}) ⇒ NodeumFileCollection

Lists files under a specific folder. **API Key Scope**: files / index

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • file_parent_id (Integer) —

    Numeric ID of parent folder.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:



346
347
348
349
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 346

def files_children_by_task(task_id, file_parent_id, opts = {})
  data, _status_code, _headers = files_children_by_task_with_http_info(task_id, file_parent_id, opts)
  data
end

#files_children_by_task_execution(task_execution_id, file_parent_id, opts = {}) ⇒ NodeumFileCollection

Lists files under a specific folder. **API Key Scope**: files / index

Parameters:

  • task_execution_id (String) —

    Numeric ID of task execution.

  • file_parent_id (Integer) —

    Numeric ID of parent folder.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:



450
451
452
453
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 450

def files_children_by_task_execution(task_execution_id, file_parent_id, opts = {})
  data, _status_code, _headers = files_children_by_task_execution_with_http_info(task_execution_id, file_parent_id, opts)
  data
end

#files_children_by_task_execution_by_task(task_id, task_execution_id, file_parent_id, opts = {}) ⇒ NodeumFileCollection

Lists files under a specific folder. **API Key Scope**: files / index

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • task_execution_id (String) —

    Numeric ID of task execution.

  • file_parent_id (Integer) —

    Numeric ID of parent folder.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:



555
556
557
558
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 555

def files_children_by_task_execution_by_task(task_id, task_execution_id, file_parent_id, opts = {})
  data, _status_code, _headers = files_children_by_task_execution_by_task_with_http_info(task_id, task_execution_id, file_parent_id, opts)
  data
end

#files_children_by_task_execution_by_task_with_http_info(task_id, task_execution_id, file_parent_id, opts = {}) ⇒ Array<(NodeumFileCollection, Integer, Hash)>

Lists files under a specific folder. **API Key Scope**: files / index

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • task_execution_id (String) —

    Numeric ID of task execution.

  • file_parent_id (Integer) —

    Numeric ID of parent folder.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:

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

    NodeumFileCollection data, response status code and response headers



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
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 579

def files_children_by_task_execution_by_task_with_http_info(task_id, task_execution_id, file_parent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.files_children_by_task_execution_by_task ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling FilesApi.files_children_by_task_execution_by_task"
  end
  # verify the required parameter 'task_execution_id' is set
  if @api_client.config.client_side_validation && task_execution_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_execution_id' when calling FilesApi.files_children_by_task_execution_by_task"
  end
  # verify the required parameter 'file_parent_id' is set
  if @api_client.config.client_side_validation && file_parent_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_parent_id' when calling FilesApi.files_children_by_task_execution_by_task"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/task_executions/{task_execution_id}/files/{file_parent_id}/children'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s)).sub('{' + 'task_execution_id' + '}', CGI.escape(task_execution_id.to_s)).sub('{' + 'file_parent_id' + '}', CGI.escape(file_parent_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[:'file_id'] = opts[:'file_id'] if !opts[:'file_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'permission'] = opts[:'permission'] if !opts[:'permission'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'change_date'] = opts[:'change_date'] if !opts[:'change_date'].nil?
  query_params[:'modification_date'] = opts[:'modification_date'] if !opts[:'modification_date'].nil?
  query_params[:'access_date'] = opts[:'access_date'] if !opts[:'access_date'].nil?
  query_params[:'gid'] = opts[:'gid'] if !opts[:'gid'].nil?
  query_params[:'uid'] = opts[:'uid'] if !opts[:'uid'].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] || 'NodeumFileCollection' 

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

#files_children_by_task_execution_with_http_info(task_execution_id, file_parent_id, opts = {}) ⇒ Array<(NodeumFileCollection, Integer, Hash)>

Lists files under a specific folder. **API Key Scope**: files / index

Parameters:

  • task_execution_id (String) —

    Numeric ID of task execution.

  • file_parent_id (Integer) —

    Numeric ID of parent folder.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:

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

    NodeumFileCollection data, response status code and response headers



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
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
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 473

def files_children_by_task_execution_with_http_info(task_execution_id, file_parent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.files_children_by_task_execution ...'
  end
  # verify the required parameter 'task_execution_id' is set
  if @api_client.config.client_side_validation && task_execution_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_execution_id' when calling FilesApi.files_children_by_task_execution"
  end
  # verify the required parameter 'file_parent_id' is set
  if @api_client.config.client_side_validation && file_parent_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_parent_id' when calling FilesApi.files_children_by_task_execution"
  end
  # resource path
  local_var_path = '/task_executions/{task_execution_id}/files/{file_parent_id}/children'.sub('{' + 'task_execution_id' + '}', CGI.escape(task_execution_id.to_s)).sub('{' + 'file_parent_id' + '}', CGI.escape(file_parent_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[:'file_id'] = opts[:'file_id'] if !opts[:'file_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'permission'] = opts[:'permission'] if !opts[:'permission'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'change_date'] = opts[:'change_date'] if !opts[:'change_date'].nil?
  query_params[:'modification_date'] = opts[:'modification_date'] if !opts[:'modification_date'].nil?
  query_params[:'access_date'] = opts[:'access_date'] if !opts[:'access_date'].nil?
  query_params[:'gid'] = opts[:'gid'] if !opts[:'gid'].nil?
  query_params[:'uid'] = opts[:'uid'] if !opts[:'uid'].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] || 'NodeumFileCollection' 

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

#files_children_by_task_with_http_info(task_id, file_parent_id, opts = {}) ⇒ Array<(NodeumFileCollection, Integer, Hash)>

Lists files under a specific folder. **API Key Scope**: files / index

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • file_parent_id (Integer) —

    Numeric ID of parent folder.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:

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

    NodeumFileCollection data, response status code and response headers



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 369

def files_children_by_task_with_http_info(task_id, file_parent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.files_children_by_task ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling FilesApi.files_children_by_task"
  end
  # verify the required parameter 'file_parent_id' is set
  if @api_client.config.client_side_validation && file_parent_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_parent_id' when calling FilesApi.files_children_by_task"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/files/{file_parent_id}/children'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s)).sub('{' + 'file_parent_id' + '}', CGI.escape(file_parent_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[:'file_id'] = opts[:'file_id'] if !opts[:'file_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'permission'] = opts[:'permission'] if !opts[:'permission'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'change_date'] = opts[:'change_date'] if !opts[:'change_date'].nil?
  query_params[:'modification_date'] = opts[:'modification_date'] if !opts[:'modification_date'].nil?
  query_params[:'access_date'] = opts[:'access_date'] if !opts[:'access_date'].nil?
  query_params[:'gid'] = opts[:'gid'] if !opts[:'gid'].nil?
  query_params[:'uid'] = opts[:'uid'] if !opts[:'uid'].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] || 'NodeumFileCollection' 

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

#files_children_with_http_info(file_parent_id, opts = {}) ⇒ Array<(NodeumFileCollection, Integer, Hash)>

Lists files under a specific folder. **API Key Scope**: files / index

Parameters:

  • file_parent_id (Integer) —

    Numeric ID of parent folder.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:

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

    NodeumFileCollection data, response status code and response headers



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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 61

def files_children_with_http_info(file_parent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.files_children ...'
  end
  # verify the required parameter 'file_parent_id' is set
  if @api_client.config.client_side_validation && file_parent_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_parent_id' when calling FilesApi.files_children"
  end
  # resource path
  local_var_path = '/files/{file_parent_id}/children'.sub('{' + 'file_parent_id' + '}', CGI.escape(file_parent_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[:'file_id'] = opts[:'file_id'] if !opts[:'file_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'permission'] = opts[:'permission'] if !opts[:'permission'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'change_date'] = opts[:'change_date'] if !opts[:'change_date'].nil?
  query_params[:'modification_date'] = opts[:'modification_date'] if !opts[:'modification_date'].nil?
  query_params[:'access_date'] = opts[:'access_date'] if !opts[:'access_date'].nil?
  query_params[:'gid'] = opts[:'gid'] if !opts[:'gid'].nil?
  query_params[:'uid'] = opts[:'uid'] if !opts[:'uid'].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] || 'NodeumFileCollection' 

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

#import_files_children_by_pool(pool_id, file_parent_id, opts = {}) ⇒ ImportFileCollection

Lists files under a specific folder on tape of pools, specific for Data Exchange. **API Key Scope**: import_files / index

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • file_parent_id (Integer) —

    Numeric ID of parent folder.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:



664
665
666
667
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 664

def import_files_children_by_pool(pool_id, file_parent_id, opts = {})
  data, _status_code, _headers = import_files_children_by_pool_with_http_info(pool_id, file_parent_id, opts)
  data
end

#import_files_children_by_pool_with_http_info(pool_id, file_parent_id, opts = {}) ⇒ Array<(ImportFileCollection, Integer, Hash)>

Lists files under a specific folder on tape of pools, specific for Data Exchange. **API Key Scope**: import_files / index

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • file_parent_id (Integer) —

    Numeric ID of parent folder.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:

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

    ImportFileCollection data, response status code and response headers



687
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
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 687

def import_files_children_by_pool_with_http_info(pool_id, file_parent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.import_files_children_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 FilesApi.import_files_children_by_pool"
  end
  # verify the required parameter 'file_parent_id' is set
  if @api_client.config.client_side_validation && file_parent_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_parent_id' when calling FilesApi.import_files_children_by_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/import_files/{file_parent_id}/children'.sub('{' + 'pool_id' + '}', CGI.escape(pool_id.to_s)).sub('{' + 'file_parent_id' + '}', CGI.escape(file_parent_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[:'file_id'] = opts[:'file_id'] if !opts[:'file_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'permission'] = opts[:'permission'] if !opts[:'permission'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'change_date'] = opts[:'change_date'] if !opts[:'change_date'].nil?
  query_params[:'modification_date'] = opts[:'modification_date'] if !opts[:'modification_date'].nil?
  query_params[:'access_date'] = opts[:'access_date'] if !opts[:'access_date'].nil?
  query_params[:'gid'] = opts[:'gid'] if !opts[:'gid'].nil?
  query_params[:'uid'] = opts[:'uid'] if !opts[:'uid'].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] || 'ImportFileCollection' 

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

#index_files(opts = {}) ⇒ NodeumFileCollection

Lists files on root. **API Key Scope**: files / 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:



766
767
768
769
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 766

def index_files(opts = {})
  data, _status_code, _headers = index_files_with_http_info(opts)
  data
end

#index_files_by_container(container_id, opts = {}) ⇒ NodeumFileCollection

Lists files on root. **API Key Scope**: files / index

Parameters:

  • container_id (String) —

    Numeric ID or name of container.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:



859
860
861
862
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 859

def index_files_by_container(container_id, opts = {})
  data, _status_code, _headers = index_files_by_container_with_http_info(container_id, opts)
  data
end

#index_files_by_container_with_http_info(container_id, opts = {}) ⇒ Array<(NodeumFileCollection, Integer, Hash)>

Lists files on root. **API Key Scope**: files / index

Parameters:

  • container_id (String) —

    Numeric ID or name of container.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:

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

    NodeumFileCollection data, response status code and response headers



881
882
883
884
885
886
887
888
889
890
891
892
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
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 881

def index_files_by_container_with_http_info(container_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.index_files_by_container ...'
  end
  # verify the required parameter 'container_id' is set
  if @api_client.config.client_side_validation && container_id.nil?
    fail ArgumentError, "Missing the required parameter 'container_id' when calling FilesApi.index_files_by_container"
  end
  # resource path
  local_var_path = '/containers/{container_id}/files'.sub('{' + 'container_id' + '}', CGI.escape(container_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[:'file_id'] = opts[:'file_id'] if !opts[:'file_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'permission'] = opts[:'permission'] if !opts[:'permission'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'change_date'] = opts[:'change_date'] if !opts[:'change_date'].nil?
  query_params[:'modification_date'] = opts[:'modification_date'] if !opts[:'modification_date'].nil?
  query_params[:'access_date'] = opts[:'access_date'] if !opts[:'access_date'].nil?
  query_params[:'gid'] = opts[:'gid'] if !opts[:'gid'].nil?
  query_params[:'uid'] = opts[:'uid'] if !opts[:'uid'].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] || 'NodeumFileCollection' 

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

#index_files_by_pool(pool_id, opts = {}) ⇒ NodeumFileCollection

Lists files on root. **API Key Scope**: files / 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:



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

def index_files_by_pool(pool_id, opts = {})
  data, _status_code, _headers = index_files_by_pool_with_http_info(pool_id, opts)
  data
end

#index_files_by_pool_with_http_info(pool_id, opts = {}) ⇒ Array<(NodeumFileCollection, Integer, Hash)>

Lists files on root. **API Key Scope**: files / 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:

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

    NodeumFileCollection data, response status code and response headers



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
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 979

def index_files_by_pool_with_http_info(pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.index_files_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 FilesApi.index_files_by_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/files'.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[:'file_id'] = opts[:'file_id'] if !opts[:'file_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'permission'] = opts[:'permission'] if !opts[:'permission'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'change_date'] = opts[:'change_date'] if !opts[:'change_date'].nil?
  query_params[:'modification_date'] = opts[:'modification_date'] if !opts[:'modification_date'].nil?
  query_params[:'access_date'] = opts[:'access_date'] if !opts[:'access_date'].nil?
  query_params[:'gid'] = opts[:'gid'] if !opts[:'gid'].nil?
  query_params[:'uid'] = opts[:'uid'] if !opts[:'uid'].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] || 'NodeumFileCollection' 

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

#index_files_by_task(task_id, opts = {}) ⇒ NodeumFileCollection

Lists files on root. **API Key Scope**: files / index

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:



1055
1056
1057
1058
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1055

def index_files_by_task(task_id, opts = {})
  data, _status_code, _headers = index_files_by_task_with_http_info(task_id, opts)
  data
end

#index_files_by_task_execution(task_execution_id, opts = {}) ⇒ NodeumFileCollection

Lists files on root. **API Key Scope**: files / index

Parameters:

  • task_execution_id (String) —

    Numeric ID of task execution.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:



1153
1154
1155
1156
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1153

def index_files_by_task_execution(task_execution_id, opts = {})
  data, _status_code, _headers = index_files_by_task_execution_with_http_info(task_execution_id, opts)
  data
end

#index_files_by_task_execution_by_task(task_id, task_execution_id, opts = {}) ⇒ NodeumFileCollection

Lists files on root. **API Key Scope**: files / index

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • task_execution_id (String) —

    Numeric ID of task execution.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:



1252
1253
1254
1255
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1252

def index_files_by_task_execution_by_task(task_id, task_execution_id, opts = {})
  data, _status_code, _headers = index_files_by_task_execution_by_task_with_http_info(task_id, task_execution_id, opts)
  data
end

#index_files_by_task_execution_by_task_with_http_info(task_id, task_execution_id, opts = {}) ⇒ Array<(NodeumFileCollection, Integer, Hash)>

Lists files on root. **API Key Scope**: files / index

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • task_execution_id (String) —

    Numeric ID of task execution.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:

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

    NodeumFileCollection data, response status code and response headers



1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1275

def index_files_by_task_execution_by_task_with_http_info(task_id, task_execution_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.index_files_by_task_execution_by_task ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling FilesApi.index_files_by_task_execution_by_task"
  end
  # verify the required parameter 'task_execution_id' is set
  if @api_client.config.client_side_validation && task_execution_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_execution_id' when calling FilesApi.index_files_by_task_execution_by_task"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/task_executions/{task_execution_id}/files'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s)).sub('{' + 'task_execution_id' + '}', CGI.escape(task_execution_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[:'file_id'] = opts[:'file_id'] if !opts[:'file_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'permission'] = opts[:'permission'] if !opts[:'permission'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'change_date'] = opts[:'change_date'] if !opts[:'change_date'].nil?
  query_params[:'modification_date'] = opts[:'modification_date'] if !opts[:'modification_date'].nil?
  query_params[:'access_date'] = opts[:'access_date'] if !opts[:'access_date'].nil?
  query_params[:'gid'] = opts[:'gid'] if !opts[:'gid'].nil?
  query_params[:'uid'] = opts[:'uid'] if !opts[:'uid'].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] || 'NodeumFileCollection' 

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

#index_files_by_task_execution_with_http_info(task_execution_id, opts = {}) ⇒ Array<(NodeumFileCollection, Integer, Hash)>

Lists files on root. **API Key Scope**: files / index

Parameters:

  • task_execution_id (String) —

    Numeric ID of task execution.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:

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

    NodeumFileCollection data, response status code and response headers



1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1175

def index_files_by_task_execution_with_http_info(task_execution_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.index_files_by_task_execution ...'
  end
  # verify the required parameter 'task_execution_id' is set
  if @api_client.config.client_side_validation && task_execution_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_execution_id' when calling FilesApi.index_files_by_task_execution"
  end
  # resource path
  local_var_path = '/task_executions/{task_execution_id}/files'.sub('{' + 'task_execution_id' + '}', CGI.escape(task_execution_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[:'file_id'] = opts[:'file_id'] if !opts[:'file_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'permission'] = opts[:'permission'] if !opts[:'permission'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'change_date'] = opts[:'change_date'] if !opts[:'change_date'].nil?
  query_params[:'modification_date'] = opts[:'modification_date'] if !opts[:'modification_date'].nil?
  query_params[:'access_date'] = opts[:'access_date'] if !opts[:'access_date'].nil?
  query_params[:'gid'] = opts[:'gid'] if !opts[:'gid'].nil?
  query_params[:'uid'] = opts[:'uid'] if !opts[:'uid'].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] || 'NodeumFileCollection' 

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

#index_files_by_task_with_http_info(task_id, opts = {}) ⇒ Array<(NodeumFileCollection, Integer, Hash)>

Lists files on root. **API Key Scope**: files / index

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:

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

    NodeumFileCollection data, response status code and response headers



1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1077

def index_files_by_task_with_http_info(task_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.index_files_by_task ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling FilesApi.index_files_by_task"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/files'.sub('{' + 'task_id' + '}', CGI.escape(task_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[:'file_id'] = opts[:'file_id'] if !opts[:'file_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'permission'] = opts[:'permission'] if !opts[:'permission'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'change_date'] = opts[:'change_date'] if !opts[:'change_date'].nil?
  query_params[:'modification_date'] = opts[:'modification_date'] if !opts[:'modification_date'].nil?
  query_params[:'access_date'] = opts[:'access_date'] if !opts[:'access_date'].nil?
  query_params[:'gid'] = opts[:'gid'] if !opts[:'gid'].nil?
  query_params[:'uid'] = opts[:'uid'] if !opts[:'uid'].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] || 'NodeumFileCollection' 

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

#index_files_with_http_info(opts = {}) ⇒ Array<(NodeumFileCollection, Integer, Hash)>

Lists files on root. **API Key Scope**: files / 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:

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

    NodeumFileCollection data, response status code and response headers



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 787

def index_files_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.index_files ...'
  end
  # resource path
  local_var_path = '/files'

  # 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[:'file_id'] = opts[:'file_id'] if !opts[:'file_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'permission'] = opts[:'permission'] if !opts[:'permission'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'change_date'] = opts[:'change_date'] if !opts[:'change_date'].nil?
  query_params[:'modification_date'] = opts[:'modification_date'] if !opts[:'modification_date'].nil?
  query_params[:'access_date'] = opts[:'access_date'] if !opts[:'access_date'].nil?
  query_params[:'gid'] = opts[:'gid'] if !opts[:'gid'].nil?
  query_params[:'uid'] = opts[:'uid'] if !opts[:'uid'].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] || 'NodeumFileCollection' 

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

#index_import_files_by_pool(pool_id, opts = {}) ⇒ ImportFileCollection

Lists files on root of tape of pools, specific for Data Exchange. **API Key Scope**: import_files / 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:



1355
1356
1357
1358
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1355

def index_import_files_by_pool(pool_id, opts = {})
  data, _status_code, _headers = index_import_files_by_pool_with_http_info(pool_id, opts)
  data
end

#index_import_files_by_pool_with_http_info(pool_id, opts = {}) ⇒ Array<(ImportFileCollection, Integer, Hash)>

Lists files on root of tape of pools, specific for Data Exchange. **API Key Scope**: import_files / 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.

  • :file_id (String) —

    Filter on file id

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :permission (String) —

    Filter on permission

  • :size (String) —

    Filter on size

  • :change_date (String) —

    Filter on change date

  • :modification_date (String) —

    Filter on modification date

  • :access_date (String) —

    Filter on access date

  • :gid (String) —

    Filter on gid

  • :uid (String) —

    Filter on uid

Returns:

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

    ImportFileCollection data, response status code and response headers



1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1377

def index_import_files_by_pool_with_http_info(pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.index_import_files_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 FilesApi.index_import_files_by_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/import_files'.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[:'file_id'] = opts[:'file_id'] if !opts[:'file_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'permission'] = opts[:'permission'] if !opts[:'permission'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'change_date'] = opts[:'change_date'] if !opts[:'change_date'].nil?
  query_params[:'modification_date'] = opts[:'modification_date'] if !opts[:'modification_date'].nil?
  query_params[:'access_date'] = opts[:'access_date'] if !opts[:'access_date'].nil?
  query_params[:'gid'] = opts[:'gid'] if !opts[:'gid'].nil?
  query_params[:'uid'] = opts[:'uid'] if !opts[:'uid'].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] || 'ImportFileCollection' 

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

#index_on_tapes_files_by_pool(pool_id, opts = {}) ⇒ OnTapesFileCollection

Lists files on root of tape of pools, specific for Active and Offline. **API Key Scope**: on_tapes_files / 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.

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :size (String) —

    Filter on size

Returns:



1446
1447
1448
1449
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1446

def index_on_tapes_files_by_pool(pool_id, opts = {})
  data, _status_code, _headers = index_on_tapes_files_by_pool_with_http_info(pool_id, opts)
  data
end

#index_on_tapes_files_by_pool_with_http_info(pool_id, opts = {}) ⇒ Array<(OnTapesFileCollection, Integer, Hash)>

Lists files on root of tape of pools, specific for Active and Offline. **API Key Scope**: on_tapes_files / 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.

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :size (String) —

    Filter on size

Returns:

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

    OnTapesFileCollection data, response status code and response headers



1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1461

def index_on_tapes_files_by_pool_with_http_info(pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.index_on_tapes_files_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 FilesApi.index_on_tapes_files_by_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/on_tapes_files'.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[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].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] || 'OnTapesFileCollection' 

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

#index_tapes_by_file_by_pool(pool_id, file_id, opts = {}) ⇒ TapeCollection

Displays tapes containing specific file, related to the specific pool. **API Key Scope**: files / tapes

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:



1519
1520
1521
1522
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1519

def index_tapes_by_file_by_pool(pool_id, file_id, opts = {})
  data, _status_code, _headers = index_tapes_by_file_by_pool_with_http_info(pool_id, file_id, opts)
  data
end

#index_tapes_by_file_by_pool_with_http_info(pool_id, file_id, opts = {}) ⇒ Array<(TapeCollection, Integer, Hash)>

Displays tapes containing specific file, related to the specific pool. **API Key Scope**: files / tapes

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:

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

    TapeCollection data, response status code and response headers



1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1530

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

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

#index_tapes_by_file_by_task(task_id, file_id, opts = {}) ⇒ TapeCollection

Displays tapes containing specific file, related to the specific task. **API Key Scope**: files / tapes

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:



1587
1588
1589
1590
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1587

def index_tapes_by_file_by_task(task_id, file_id, opts = {})
  data, _status_code, _headers = index_tapes_by_file_by_task_with_http_info(task_id, file_id, opts)
  data
end

#index_tapes_by_file_by_task_execution(task_execution_id, file_id, opts = {}) ⇒ TapeCollection

Displays tapes containing specific file, related to the specific task. **API Key Scope**: files / tapes

Parameters:

  • task_execution_id (String) —

    Numeric ID of task execution.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:



1655
1656
1657
1658
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1655

def index_tapes_by_file_by_task_execution(task_execution_id, file_id, opts = {})
  data, _status_code, _headers = index_tapes_by_file_by_task_execution_with_http_info(task_execution_id, file_id, opts)
  data
end

#index_tapes_by_file_by_task_execution_by_task(task_id, task_execution_id, file_id, opts = {}) ⇒ TapeCollection

Displays tapes containing specific file, related to the specific task. **API Key Scope**: files / tapes

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • task_execution_id (String) —

    Numeric ID of task execution.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:



1724
1725
1726
1727
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1724

def index_tapes_by_file_by_task_execution_by_task(task_id, task_execution_id, file_id, opts = {})
  data, _status_code, _headers = index_tapes_by_file_by_task_execution_by_task_with_http_info(task_id, task_execution_id, file_id, opts)
  data
end

#index_tapes_by_file_by_task_execution_by_task_with_http_info(task_id, task_execution_id, file_id, opts = {}) ⇒ Array<(TapeCollection, Integer, Hash)>

Displays tapes containing specific file, related to the specific task. **API Key Scope**: files / tapes

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • task_execution_id (String) —

    Numeric ID of task execution.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:

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

    TapeCollection data, response status code and response headers



1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1736

def index_tapes_by_file_by_task_execution_by_task_with_http_info(task_id, task_execution_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.index_tapes_by_file_by_task_execution_by_task ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling FilesApi.index_tapes_by_file_by_task_execution_by_task"
  end
  # verify the required parameter 'task_execution_id' is set
  if @api_client.config.client_side_validation && task_execution_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_execution_id' when calling FilesApi.index_tapes_by_file_by_task_execution_by_task"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.index_tapes_by_file_by_task_execution_by_task"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/task_executions/{task_execution_id}/files/{file_id}/tapes'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s)).sub('{' + 'task_execution_id' + '}', CGI.escape(task_execution_id.to_s)).sub('{' + 'file_id' + '}', CGI.escape(file_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] || 'TapeCollection' 

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

#index_tapes_by_file_by_task_execution_with_http_info(task_execution_id, file_id, opts = {}) ⇒ Array<(TapeCollection, Integer, Hash)>

Displays tapes containing specific file, related to the specific task. **API Key Scope**: files / tapes

Parameters:

  • task_execution_id (String) —

    Numeric ID of task execution.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:

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

    TapeCollection data, response status code and response headers



1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1666

def index_tapes_by_file_by_task_execution_with_http_info(task_execution_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.index_tapes_by_file_by_task_execution ...'
  end
  # verify the required parameter 'task_execution_id' is set
  if @api_client.config.client_side_validation && task_execution_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_execution_id' when calling FilesApi.index_tapes_by_file_by_task_execution"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.index_tapes_by_file_by_task_execution"
  end
  # resource path
  local_var_path = '/task_executions/{task_execution_id}/files/{file_id}/tapes'.sub('{' + 'task_execution_id' + '}', CGI.escape(task_execution_id.to_s)).sub('{' + 'file_id' + '}', CGI.escape(file_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] || 'TapeCollection' 

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

#index_tapes_by_file_by_task_with_http_info(task_id, file_id, opts = {}) ⇒ Array<(TapeCollection, Integer, Hash)>

Displays tapes containing specific file, related to the specific task. **API Key Scope**: files / tapes

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:

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

    TapeCollection data, response status code and response headers



1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1598

def index_tapes_by_file_by_task_with_http_info(task_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.index_tapes_by_file_by_task ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling FilesApi.index_tapes_by_file_by_task"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.index_tapes_by_file_by_task"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/files/{file_id}/tapes'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s)).sub('{' + 'file_id' + '}', CGI.escape(file_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] || 'TapeCollection' 

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

#on_tapes_files_children_by_pool(pool_id, file_parent_id, opts = {}) ⇒ OnTapesFileCollection

Lists files under a specific folder on tape of pools, specific for Active and Offline. **API Key Scope**: on_tapes_files / index

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • file_parent_id (Integer) —

    Numeric ID of parent folder.

  • 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.

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :size (String) —

    Filter on size

Returns:



1802
1803
1804
1805
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1802

def on_tapes_files_children_by_pool(pool_id, file_parent_id, opts = {})
  data, _status_code, _headers = on_tapes_files_children_by_pool_with_http_info(pool_id, file_parent_id, opts)
  data
end

#on_tapes_files_children_by_pool_with_http_info(pool_id, file_parent_id, opts = {}) ⇒ Array<(OnTapesFileCollection, Integer, Hash)>

Lists files under a specific folder on tape of pools, specific for Active and Offline. **API Key Scope**: on_tapes_files / index

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • file_parent_id (Integer) —

    Numeric ID of parent folder.

  • 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.

  • :name (String) —

    Filter on name

  • :type (String) —

    Filter on type

  • :size (String) —

    Filter on size

Returns:

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

    OnTapesFileCollection data, response status code and response headers



1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1818

def on_tapes_files_children_by_pool_with_http_info(pool_id, file_parent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.on_tapes_files_children_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 FilesApi.on_tapes_files_children_by_pool"
  end
  # verify the required parameter 'file_parent_id' is set
  if @api_client.config.client_side_validation && file_parent_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_parent_id' when calling FilesApi.on_tapes_files_children_by_pool"
  end
  # resource path
  local_var_path = '/pools/{pool_id}/on_tapes_files/{file_parent_id}/children'.sub('{' + 'pool_id' + '}', CGI.escape(pool_id.to_s)).sub('{' + 'file_parent_id' + '}', CGI.escape(file_parent_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[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].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] || 'OnTapesFileCollection' 

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

#show_file(file_id, opts = {}) ⇒ NodeumFileWithPath

Displays a specific file. **API Key Scope**: files / show

Parameters:

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:



1879
1880
1881
1882
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1879

def show_file(file_id, opts = {})
  data, _status_code, _headers = show_file_with_http_info(file_id, opts)
  data
end

#show_file_by_container(container_id, file_id, opts = {}) ⇒ NodeumFileWithPath

Displays a specific file. **API Key Scope**: files / show

Parameters:

  • container_id (String) —

    Numeric ID or name of container.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:



1942
1943
1944
1945
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1942

def show_file_by_container(container_id, file_id, opts = {})
  data, _status_code, _headers = show_file_by_container_with_http_info(container_id, file_id, opts)
  data
end

#show_file_by_container_with_http_info(container_id, file_id, opts = {}) ⇒ Array<(NodeumFileWithPath, Integer, Hash)>

Displays a specific file. **API Key Scope**: files / show

Parameters:

  • container_id (String) —

    Numeric ID or name of container.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:

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

    NodeumFileWithPath data, response status code and response headers



1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1953

def show_file_by_container_with_http_info(container_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.show_file_by_container ...'
  end
  # verify the required parameter 'container_id' is set
  if @api_client.config.client_side_validation && container_id.nil?
    fail ArgumentError, "Missing the required parameter 'container_id' when calling FilesApi.show_file_by_container"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.show_file_by_container"
  end
  # resource path
  local_var_path = '/containers/{container_id}/files/{file_id}'.sub('{' + 'container_id' + '}', CGI.escape(container_id.to_s)).sub('{' + 'file_id' + '}', CGI.escape(file_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] || 'NodeumFileWithPath' 

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

#show_file_by_pool(pool_id, file_id, opts = {}) ⇒ NodeumFileWithPath

Displays a specific file. **API Key Scope**: files / show

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:



2010
2011
2012
2013
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 2010

def show_file_by_pool(pool_id, file_id, opts = {})
  data, _status_code, _headers = show_file_by_pool_with_http_info(pool_id, file_id, opts)
  data
end

#show_file_by_pool_with_http_info(pool_id, file_id, opts = {}) ⇒ Array<(NodeumFileWithPath, Integer, Hash)>

Displays a specific file. **API Key Scope**: files / show

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:

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

    NodeumFileWithPath data, response status code and response headers



2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 2021

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

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

#show_file_by_task(task_id, file_id, opts = {}) ⇒ NodeumFileWithPath

Displays a specific file. **API Key Scope**: files / show

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:



2078
2079
2080
2081
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 2078

def show_file_by_task(task_id, file_id, opts = {})
  data, _status_code, _headers = show_file_by_task_with_http_info(task_id, file_id, opts)
  data
end

#show_file_by_task_execution(task_execution_id, file_id, opts = {}) ⇒ NodeumFileWithPath

Displays a specific file. **API Key Scope**: files / show

Parameters:

  • task_execution_id (String) —

    Numeric ID of task execution.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:



2146
2147
2148
2149
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 2146

def show_file_by_task_execution(task_execution_id, file_id, opts = {})
  data, _status_code, _headers = show_file_by_task_execution_with_http_info(task_execution_id, file_id, opts)
  data
end

#show_file_by_task_execution_by_task(task_id, task_execution_id, file_id, opts = {}) ⇒ NodeumFileWithPath

Displays a specific file. **API Key Scope**: files / show

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • task_execution_id (String) —

    Numeric ID of task execution.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:



2215
2216
2217
2218
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 2215

def show_file_by_task_execution_by_task(task_id, task_execution_id, file_id, opts = {})
  data, _status_code, _headers = show_file_by_task_execution_by_task_with_http_info(task_id, task_execution_id, file_id, opts)
  data
end

#show_file_by_task_execution_by_task_with_http_info(task_id, task_execution_id, file_id, opts = {}) ⇒ Array<(NodeumFileWithPath, Integer, Hash)>

Displays a specific file. **API Key Scope**: files / show

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • task_execution_id (String) —

    Numeric ID of task execution.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:

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

    NodeumFileWithPath data, response status code and response headers



2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 2227

def show_file_by_task_execution_by_task_with_http_info(task_id, task_execution_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.show_file_by_task_execution_by_task ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling FilesApi.show_file_by_task_execution_by_task"
  end
  # verify the required parameter 'task_execution_id' is set
  if @api_client.config.client_side_validation && task_execution_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_execution_id' when calling FilesApi.show_file_by_task_execution_by_task"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.show_file_by_task_execution_by_task"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/task_executions/{task_execution_id}/files/{file_id}'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s)).sub('{' + 'task_execution_id' + '}', CGI.escape(task_execution_id.to_s)).sub('{' + 'file_id' + '}', CGI.escape(file_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] || 'NodeumFileWithPath' 

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

#show_file_by_task_execution_with_http_info(task_execution_id, file_id, opts = {}) ⇒ Array<(NodeumFileWithPath, Integer, Hash)>

Displays a specific file. **API Key Scope**: files / show

Parameters:

  • task_execution_id (String) —

    Numeric ID of task execution.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:

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

    NodeumFileWithPath data, response status code and response headers



2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 2157

def show_file_by_task_execution_with_http_info(task_execution_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.show_file_by_task_execution ...'
  end
  # verify the required parameter 'task_execution_id' is set
  if @api_client.config.client_side_validation && task_execution_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_execution_id' when calling FilesApi.show_file_by_task_execution"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.show_file_by_task_execution"
  end
  # resource path
  local_var_path = '/task_executions/{task_execution_id}/files/{file_id}'.sub('{' + 'task_execution_id' + '}', CGI.escape(task_execution_id.to_s)).sub('{' + 'file_id' + '}', CGI.escape(file_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] || 'NodeumFileWithPath' 

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

#show_file_by_task_with_http_info(task_id, file_id, opts = {}) ⇒ Array<(NodeumFileWithPath, Integer, Hash)>

Displays a specific file. **API Key Scope**: files / show

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:

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

    NodeumFileWithPath data, response status code and response headers



2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 2089

def show_file_by_task_with_http_info(task_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.show_file_by_task ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling FilesApi.show_file_by_task"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.show_file_by_task"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/files/{file_id}'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s)).sub('{' + 'file_id' + '}', CGI.escape(file_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] || 'NodeumFileWithPath' 

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

#show_file_with_http_info(file_id, opts = {}) ⇒ Array<(NodeumFileWithPath, Integer, Hash)>

Displays a specific file. **API Key Scope**: files / show

Parameters:

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:

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

    NodeumFileWithPath data, response status code and response headers



1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 1889

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

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

#show_import_file_by_pool(pool_id, file_id, opts = {}) ⇒ ImportFileWithPath

Displays a specific file on tape of pools, specific for Data Exchange. **API Key Scope**: import_files / show

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:



2288
2289
2290
2291
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 2288

def show_import_file_by_pool(pool_id, file_id, opts = {})
  data, _status_code, _headers = show_import_file_by_pool_with_http_info(pool_id, file_id, opts)
  data
end

#show_import_file_by_pool_with_http_info(pool_id, file_id, opts = {}) ⇒ Array<(ImportFileWithPath, Integer, Hash)>

Displays a specific file on tape of pools, specific for Data Exchange. **API Key Scope**: import_files / show

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:

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

    ImportFileWithPath data, response status code and response headers



2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 2299

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

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

#show_on_tape_file_by_pool(pool_id, file_id, opts = {}) ⇒ OnTapesFile

Displays a specific file on tape of pools, specific for Active and Offline. **API Key Scope**: on_tapes_files / show

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:



2356
2357
2358
2359
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 2356

def show_on_tape_file_by_pool(pool_id, file_id, opts = {})
  data, _status_code, _headers = show_on_tape_file_by_pool_with_http_info(pool_id, file_id, opts)
  data
end

#show_on_tape_file_by_pool_with_http_info(pool_id, file_id, opts = {}) ⇒ Array<(OnTapesFile, Integer, Hash)>

Displays a specific file on tape of pools, specific for Active and Offline. **API Key Scope**: on_tapes_files / show

Parameters:

  • pool_id (String) —

    Numeric ID, or name of pool.

  • file_id (Integer) —

    Numeric ID of file.

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

    the optional parameters

Returns:

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

    OnTapesFile data, response status code and response headers



2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
 
# File 'lib/nodeum_sdk/api/files_api.rb', line 2367

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

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