class Nodeum::SystemsApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

download_reset_vars(reset_form, opts = {}) click to toggle source

Creates a YAML file with selected tables and downloads it @param reset_form [Reset] @param [Hash] opts the optional parameters @return [File]

# File lib/nodeum_sdk/api/systems_api.rb, line 26
def download_reset_vars(reset_form, opts = {})
  data, _status_code, _headers = download_reset_vars_with_http_info(reset_form, opts)
  data
end
download_reset_vars_with_http_info(reset_form, opts = {}) click to toggle source

Creates a YAML file with selected tables and downloads it @param reset_form [Reset] @param [Hash] opts the optional parameters @return [Array<(File, Integer, Hash)>] File data, response status code and response headers

# File lib/nodeum_sdk/api/systems_api.rb, line 35
def download_reset_vars_with_http_info(reset_form, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SystemsApi.download_reset_vars ...'
  end
  # verify the required parameter 'reset_form' is set
  if @api_client.config.client_side_validation && reset_form.nil?
    fail ArgumentError, "Missing the required parameter 'reset_form' when calling SystemsApi.download_reset_vars"
  end
  # resource path
  local_var_path = '/systems/reset/generate_vars'

  # 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/x-yaml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(reset_form) 

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SystemsApi#download_reset_vars\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
result_download_traces(job_id, opts = {}) click to toggle source

Check result of a download traces job. **API Key Scope**: systems / download_traces @param job_id [String] ID of active job @param [Hash] opts the optional parameters @return [File]

# File lib/nodeum_sdk/api/systems_api.rb, line 89
def result_download_traces(job_id, opts = {})
  data, _status_code, _headers = result_download_traces_with_http_info(job_id, opts)
  data
end
result_download_traces_with_http_info(job_id, opts = {}) click to toggle source

Check result of a download traces job. **API Key Scope**: systems / download_traces @param job_id [String] ID of active job @param [Hash] opts the optional parameters @return [Array<(File, Integer, Hash)>] File data, response status code and response headers

# File lib/nodeum_sdk/api/systems_api.rb, line 99
def result_download_traces_with_http_info(job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SystemsApi.result_download_traces ...'
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling SystemsApi.result_download_traces"
  end
  # resource path
  local_var_path = '/systems/download_traces'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/tar+gzip', 'queued', 'working', 'failed', ])

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

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

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

  # 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: SystemsApi#result_download_traces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
trigger_download_traces(type, opts = {}) click to toggle source

Trigger a download traces request. **API Key Scope**: systems / download_traces @param type [String] Type of traces to download @param [Hash] opts the optional parameters @return [ActiveJobStatus]

# File lib/nodeum_sdk/api/systems_api.rb, line 152
def trigger_download_traces(type, opts = {})
  data, _status_code, _headers = trigger_download_traces_with_http_info(type, opts)
  data
end
trigger_download_traces_with_http_info(type, opts = {}) click to toggle source

Trigger a download traces request. **API Key Scope**: systems / download_traces @param type [String] Type of traces to download @param [Hash] opts the optional parameters @return [Array<(ActiveJobStatus, Integer, Hash)>] ActiveJobStatus data, response status code and response headers

# File lib/nodeum_sdk/api/systems_api.rb, line 162
def trigger_download_traces_with_http_info(type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SystemsApi.trigger_download_traces ...'
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling SystemsApi.trigger_download_traces"
  end
  # verify enum value
  allowable_values = ["interface", "core", "data_mining", "fuse", "library_manager", "manager", "watchdog", "system", "all"]
  if @api_client.config.client_side_validation && !allowable_values.include?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/systems/download_traces'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'queued', 'working', 'failed'])

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

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

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SystemsApi#trigger_download_traces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end