Class: Falcon::NetworkScanScanRunReports

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/network_scan_scan_run_reports.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NetworkScanScanRunReports

Returns a new instance of NetworkScanScanRunReports.



35
36
37
 
# File 'lib/crimson-falcon/api/network_scan_scan_run_reports.rb', line 35

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



33
34
35
 
# File 'lib/crimson-falcon/api/network_scan_scan_run_reports.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#get_scan_run_reports(id, opts = {}) ⇒ nil

Downloads scan run report in CSV format

Parameters:

  • id (String) —

    Scan run ID for which report is to be fetched

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

    the optional parameters

Options Hash (opts):

  • :x_cs_useruuid (String) —

    User UUID

Returns:

  • (nil) 


43
44
45
46
 
# File 'lib/crimson-falcon/api/network_scan_scan_run_reports.rb', line 43

def get_scan_run_reports(id, opts = {})
  get_scan_run_reports_with_http_info(id, opts)
  nil
end

#get_scan_run_reports_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Downloads scan run report in CSV format

Parameters:

  • id (String) —

    Scan run ID for which report is to be fetched

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

    the optional parameters

Options Hash (opts):

  • :x_cs_useruuid (String) —

    User UUID

Returns:

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

    nil, response status code and response headers



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/crimson-falcon/api/network_scan_scan_run_reports.rb', line 53

def get_scan_run_reports_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkScanScanRunReports.get_scan_run_reports ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling NetworkScanScanRunReports.get_scan_run_reports"
  end
  # resource path
  local_var_path = '/netscan/entities/scan-run-reports/v1'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv', 'application/json'])
  header_params[:'X-CS-USERUUID'] = opts[:'x_cs_useruuid'] if !opts[:'x_cs_useruuid'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"NetworkScanScanRunReports.get_scan_run_reports",
    :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: NetworkScanScanRunReports#get_scan_run_reports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end