class EmassClient::ArtifactsExportApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

get_system_artifacts_export(system_id, filename, opts = {}) click to toggle source

Get the file of an artifact in a system <strong>Sample Responce</strong>
Binary file associated with given filename.
If ‘compress` parameter is specified, zip archive of binary file associated with given filename. @param system_id **System Id**: The unique system record identifier. @param filename **File Name**: The file name (to include file-extension). @param [Hash] opts the optional parameters @option opts [BOOLEAN] :compress **Compress File**: Determines if returned file is compressed. (default to true) @return [String]

# File lib/emass_client/api/artifacts_export_api.rb, line 26
def get_system_artifacts_export(system_id, filename, opts = {})
  data, _status_code, _headers = get_system_artifacts_export_with_http_info(system_id, filename, opts)
  data
end
get_system_artifacts_export_with_http_info(system_id, filename, opts = {}) click to toggle source

Get the file of an artifact in a system &lt;strong&gt;Sample Responce&lt;/strong&gt;&lt;br&gt; Binary file associated with given filename.&lt;br&gt; If &#x60;compress&#x60; parameter is specified, zip archive of binary file associated with given filename. @param system_id **System Id**: The unique system record identifier. @param filename **File Name**: The file name (to include file-extension). @param [Hash] opts the optional parameters @option opts [BOOLEAN] :compress **Compress File**: Determines if returned file is compressed. @return [Array<(String, Integer, Hash)>] String data, response status code and response headers

# File lib/emass_client/api/artifacts_export_api.rb, line 38
def get_system_artifacts_export_with_http_info(system_id, filename, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArtifactsExportApi.get_system_artifacts_export ...'
  end
  # verify the required parameter 'system_id' is set
  if @api_client.config.client_side_validation && system_id.nil?
    fail ArgumentError, "Missing the required parameter 'system_id' when calling ArtifactsExportApi.get_system_artifacts_export"
  end
  # verify the required parameter 'filename' is set
  if @api_client.config.client_side_validation && filename.nil?
    fail ArgumentError, "Missing the required parameter 'filename' when calling ArtifactsExportApi.get_system_artifacts_export"
  end
  # resource path
  local_var_path = '/api/systems/{systemId}/artifacts-export'.sub('{' + 'systemId' + '}', system_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filename'] = filename
  query_params[:'compress'] = opts[:'compress'] if !opts[:'compress'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/octet-stream', 'application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['apikey', 'mockType', 'userid']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArtifactsExportApi#get_system_artifacts_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end