class Nodeum::FilesApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/nodeum_sdk/api/files_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

files_children(file_parent_id, opts = {}) click to toggle source

Lists files under a specific folder. **API Key Scope**: files / index @param file_parent_id [Integer] Numeric ID of parent folder. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [NodeumFileCollection]

# 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 = {}) click to toggle source

Lists files under a specific folder. **API Key Scope**: files / index @param container_id [String] Numeric ID or name of container. @param file_parent_id [Integer] Numeric ID of parent folder. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [NodeumFileCollection]

# 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 = {}) click to toggle source

Lists files under a specific folder. **API Key Scope**: files / index @param container_id [String] Numeric ID or name of container. @param file_parent_id [Integer] Numeric ID of parent folder. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [Array<(NodeumFileCollection, Integer, Hash)>] NodeumFileCollection data, response status code and response headers

# 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 = {}) click to toggle source

Lists files under a specific folder. **API Key Scope**: files / index @param pool_id [String] Numeric ID, or name of pool. @param file_parent_id [Integer] Numeric ID of parent folder. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [NodeumFileCollection]

# 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 = {}) click to toggle source

Lists files under a specific folder. **API Key Scope**: files / index @param pool_id [String] Numeric ID, or name of pool. @param file_parent_id [Integer] Numeric ID of parent folder. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [Array<(NodeumFileCollection, Integer, Hash)>] NodeumFileCollection data, response status code and response headers

# 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 = {}) click to toggle source

Lists files under a specific folder. **API Key Scope**: files / index @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param file_parent_id [Integer] Numeric ID of parent folder. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [NodeumFileCollection]

# 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 = {}) click to toggle source

Lists files under a specific folder. **API Key Scope**: files / index @param task_execution_id [String] Numeric ID of task execution. @param file_parent_id [Integer] Numeric ID of parent folder. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [NodeumFileCollection]

# 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 = {}) click to toggle source

Lists files under a specific folder. **API Key Scope**: files / index @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param task_execution_id [String] Numeric ID of task execution. @param file_parent_id [Integer] Numeric ID of parent folder. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [NodeumFileCollection]

# 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 = {}) click to toggle source

Lists files under a specific folder. **API Key Scope**: files / index @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param task_execution_id [String] Numeric ID of task execution. @param file_parent_id [Integer] Numeric ID of parent folder. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [Array<(NodeumFileCollection, Integer, Hash)>] NodeumFileCollection data, response status code and response headers

# 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 = {}) click to toggle source

Lists files under a specific folder. **API Key Scope**: files / index @param task_execution_id [String] Numeric ID of task execution. @param file_parent_id [Integer] Numeric ID of parent folder. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [Array<(NodeumFileCollection, Integer, Hash)>] NodeumFileCollection data, response status code and response headers

# 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 = {}) click to toggle source

Lists files under a specific folder. **API Key Scope**: files / index @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param file_parent_id [Integer] Numeric ID of parent folder. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [Array<(NodeumFileCollection, Integer, Hash)>] NodeumFileCollection data, response status code and response headers

# 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 = {}) click to toggle source

Lists files under a specific folder. **API Key Scope**: files / index @param file_parent_id [Integer] Numeric ID of parent folder. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [Array<(NodeumFileCollection, Integer, Hash)>] NodeumFileCollection data, response status code and response headers

# 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 = {}) click to toggle source

Lists files under a specific folder on tape of pools, specific for Data Exchange. **API Key Scope**: import_files / index @param pool_id [String] Numeric ID, or name of pool. @param file_parent_id [Integer] Numeric ID of parent folder. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [ImportFileCollection]

# 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 = {}) click to toggle source

Lists files under a specific folder on tape of pools, specific for Data Exchange. **API Key Scope**: import_files / index @param pool_id [String] Numeric ID, or name of pool. @param file_parent_id [Integer] Numeric ID of parent folder. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [Array<(ImportFileCollection, Integer, Hash)>] ImportFileCollection data, response status code and response headers

# 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 = {}) click to toggle source

Lists files on root. **API Key Scope**: files / index @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [NodeumFileCollection]

# 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 = {}) click to toggle source

Lists files on root. **API Key Scope**: files / index @param container_id [String] Numeric ID or name of container. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [NodeumFileCollection]

# 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 = {}) click to toggle source

Lists files on root. **API Key Scope**: files / index @param container_id [String] Numeric ID or name of container. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [Array<(NodeumFileCollection, Integer, Hash)>] NodeumFileCollection data, response status code and response headers

# 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 = {}) click to toggle source

Lists files on root. **API Key Scope**: files / index @param pool_id [String] Numeric ID, or name of pool. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [NodeumFileCollection]

# 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 = {}) click to toggle source

Lists files on root. **API Key Scope**: files / index @param pool_id [String] Numeric ID, or name of pool. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [Array<(NodeumFileCollection, Integer, Hash)>] NodeumFileCollection data, response status code and response headers

# 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 = {}) click to toggle source

Lists files on root. **API Key Scope**: files / index @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [NodeumFileCollection]

# 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 = {}) click to toggle source

Lists files on root. **API Key Scope**: files / index @param task_execution_id [String] Numeric ID of task execution. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [NodeumFileCollection]

# 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 = {}) click to toggle source

Lists files on root. **API Key Scope**: files / index @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param task_execution_id [String] Numeric ID of task execution. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [NodeumFileCollection]

# 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 = {}) click to toggle source

Lists files on root. **API Key Scope**: files / index @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param task_execution_id [String] Numeric ID of task execution. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [Array<(NodeumFileCollection, Integer, Hash)>] NodeumFileCollection data, response status code and response headers

# 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 = {}) click to toggle source

Lists files on root. **API Key Scope**: files / index @param task_execution_id [String] Numeric ID of task execution. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [Array<(NodeumFileCollection, Integer, Hash)>] NodeumFileCollection data, response status code and response headers

# 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 = {}) click to toggle source

Lists files on root. **API Key Scope**: files / index @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [Array<(NodeumFileCollection, Integer, Hash)>] NodeumFileCollection data, response status code and response headers

# 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 = {}) click to toggle source

Lists files on root. **API Key Scope**: files / index @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [Array<(NodeumFileCollection, Integer, Hash)>] NodeumFileCollection data, response status code and response headers

# 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 = {}) click to toggle source

Lists files on root of tape of pools, specific for Data Exchange. **API Key Scope**: import_files / index @param pool_id [String] Numeric ID, or name of pool. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [ImportFileCollection]

# 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 = {}) click to toggle source

Lists files on root of tape of pools, specific for Data Exchange. **API Key Scope**: import_files / index @param pool_id [String] Numeric ID, or name of pool. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :file_id Filter on file id @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :permission Filter on permission @option opts [String] :size Filter on size @option opts [String] :change_date Filter on change date @option opts [String] :modification_date Filter on modification date @option opts [String] :access_date Filter on access date @option opts [String] :gid Filter on gid @option opts [String] :uid Filter on uid @return [Array<(ImportFileCollection, Integer, Hash)>] ImportFileCollection data, response status code and response headers

# 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 = {}) click to toggle source

Lists files on root of tape of pools, specific for Active and Offline. **API Key Scope**: on_tapes_files / index @param pool_id [String] Numeric ID, or name of pool. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :size Filter on size @return [OnTapesFileCollection]

# 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 = {}) click to toggle source

Lists files on root of tape of pools, specific for Active and Offline. **API Key Scope**: on_tapes_files / index @param pool_id [String] Numeric ID, or name of pool. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :size Filter on size @return [Array<(OnTapesFileCollection, Integer, Hash)>] OnTapesFileCollection data, response status code and response headers

# 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 = {}) click to toggle source

Displays tapes containing specific file, related to the specific pool. **API Key Scope**: files / tapes @param pool_id [String] Numeric ID, or name of pool. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [TapeCollection]

# 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 = {}) click to toggle source

Displays tapes containing specific file, related to the specific pool. **API Key Scope**: files / tapes @param pool_id [String] Numeric ID, or name of pool. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [Array<(TapeCollection, Integer, Hash)>] TapeCollection data, response status code and response headers

# 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 = {}) click to toggle source

Displays tapes containing specific file, related to the specific task. **API Key Scope**: files / tapes @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [TapeCollection]

# 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 = {}) click to toggle source

Displays tapes containing specific file, related to the specific task. **API Key Scope**: files / tapes @param task_execution_id [String] Numeric ID of task execution. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [TapeCollection]

# 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 = {}) click to toggle source

Displays tapes containing specific file, related to the specific task. **API Key Scope**: files / tapes @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param task_execution_id [String] Numeric ID of task execution. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [TapeCollection]

# 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 = {}) click to toggle source

Displays tapes containing specific file, related to the specific task. **API Key Scope**: files / tapes @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param task_execution_id [String] Numeric ID of task execution. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [Array<(TapeCollection, Integer, Hash)>] TapeCollection data, response status code and response headers

# 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 = {}) click to toggle source

Displays tapes containing specific file, related to the specific task. **API Key Scope**: files / tapes @param task_execution_id [String] Numeric ID of task execution. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [Array<(TapeCollection, Integer, Hash)>] TapeCollection data, response status code and response headers

# 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 = {}) click to toggle source

Displays tapes containing specific file, related to the specific task. **API Key Scope**: files / tapes @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [Array<(TapeCollection, Integer, Hash)>] TapeCollection data, response status code and response headers

# 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 = {}) click to toggle source

Lists files under a specific folder on tape of pools, specific for Active and Offline. **API Key Scope**: on_tapes_files / index @param pool_id [String] Numeric ID, or name of pool. @param file_parent_id [Integer] Numeric ID of parent folder. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :size Filter on size @return [OnTapesFileCollection]

# 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 = {}) click to toggle source

Lists files under a specific folder on tape of pools, specific for Active and Offline. **API Key Scope**: on_tapes_files / index @param pool_id [String] Numeric ID, or name of pool. @param file_parent_id [Integer] Numeric ID of parent folder. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [String] :name Filter on name @option opts [String] :type Filter on type @option opts [String] :size Filter on size @return [Array<(OnTapesFileCollection, Integer, Hash)>] OnTapesFileCollection data, response status code and response headers

# 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 = {}) click to toggle source

Displays a specific file. **API Key Scope**: files / show @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [NodeumFileWithPath]

# 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 = {}) click to toggle source

Displays a specific file. **API Key Scope**: files / show @param container_id [String] Numeric ID or name of container. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [NodeumFileWithPath]

# 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 = {}) click to toggle source

Displays a specific file. **API Key Scope**: files / show @param container_id [String] Numeric ID or name of container. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [Array<(NodeumFileWithPath, Integer, Hash)>] NodeumFileWithPath data, response status code and response headers

# 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 = {}) click to toggle source

Displays a specific file. **API Key Scope**: files / show @param pool_id [String] Numeric ID, or name of pool. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [NodeumFileWithPath]

# 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 = {}) click to toggle source

Displays a specific file. **API Key Scope**: files / show @param pool_id [String] Numeric ID, or name of pool. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [Array<(NodeumFileWithPath, Integer, Hash)>] NodeumFileWithPath data, response status code and response headers

# 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 = {}) click to toggle source

Displays a specific file. **API Key Scope**: files / show @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [NodeumFileWithPath]

# 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 = {}) click to toggle source

Displays a specific file. **API Key Scope**: files / show @param task_execution_id [String] Numeric ID of task execution. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [NodeumFileWithPath]

# 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 = {}) click to toggle source

Displays a specific file. **API Key Scope**: files / show @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param task_execution_id [String] Numeric ID of task execution. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [NodeumFileWithPath]

# 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 = {}) click to toggle source

Displays a specific file. **API Key Scope**: files / show @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param task_execution_id [String] Numeric ID of task execution. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [Array<(NodeumFileWithPath, Integer, Hash)>] NodeumFileWithPath data, response status code and response headers

# 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 = {}) click to toggle source

Displays a specific file. **API Key Scope**: files / show @param task_execution_id [String] Numeric ID of task execution. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [Array<(NodeumFileWithPath, Integer, Hash)>] NodeumFileWithPath data, response status code and response headers

# 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 = {}) click to toggle source

Displays a specific file. **API Key Scope**: files / show @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [Array<(NodeumFileWithPath, Integer, Hash)>] NodeumFileWithPath data, response status code and response headers

# 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 = {}) click to toggle source

Displays a specific file. **API Key Scope**: files / show @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [Array<(NodeumFileWithPath, Integer, Hash)>] NodeumFileWithPath data, response status code and response headers

# 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 = {}) click to toggle source

Displays a specific file on tape of pools, specific for Data Exchange. **API Key Scope**: import_files / show @param pool_id [String] Numeric ID, or name of pool. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [ImportFileWithPath]

# 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 = {}) click to toggle source

Displays a specific file on tape of pools, specific for Data Exchange. **API Key Scope**: import_files / show @param pool_id [String] Numeric ID, or name of pool. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [Array<(ImportFileWithPath, Integer, Hash)>] ImportFileWithPath data, response status code and response headers

# 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 = {}) click to toggle source

Displays a specific file on tape of pools, specific for Active and Offline. **API Key Scope**: on_tapes_files / show @param pool_id [String] Numeric ID, or name of pool. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [OnTapesFile]

# 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 = {}) click to toggle source

Displays a specific file on tape of pools, specific for Active and Offline. **API Key Scope**: on_tapes_files / show @param pool_id [String] Numeric ID, or name of pool. @param file_id [Integer] Numeric ID of file. @param [Hash] opts the optional parameters @return [Array<(OnTapesFile, Integer, Hash)>] OnTapesFile data, response status code and response headers

# 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