Class: Falcon::ActivityMonitor

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ActivityMonitor

Returns a new instance of ActivityMonitor.



36
37
38
 
# File 'lib/crimson-falcon/api/activity_monitor.rb', line 36

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/activity_monitor.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#get_activity_monitor_v3(opts = {}) ⇒ GetActivityMonitor

GET Activity Monitor Get a list of all events in monitor

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :integration_id (String) —

    Integration ID

  • :actor (String) —

    Actor

  • :category (String) —

    Comma separated list of categories

  • :projection (String) —

    Comma separated list of projections

  • :from_date (Time) —

    From Date

  • :to_date (Time) —

    To Date

  • :limit (Integer) —

    Max number of logs to fetch

  • :skip (Integer) —

    Number of logs to skip

Returns:



51
52
53
54
 
# File 'lib/crimson-falcon/api/activity_monitor.rb', line 51

def get_activity_monitor_v3(opts = {})
  data, _status_code, _headers = get_activity_monitor_v3_with_http_info(opts)
  data
end

#get_activity_monitor_v3_with_http_info(opts = {}) ⇒ Array<(GetActivityMonitor, Integer, Hash)>

GET Activity Monitor Get a list of all events in monitor

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :integration_id (String) —

    Integration ID

  • :actor (String) —

    Actor

  • :category (String) —

    Comma separated list of categories

  • :projection (String) —

    Comma separated list of projections

  • :from_date (Time) —

    From Date

  • :to_date (Time) —

    To Date

  • :limit (Integer) —

    Max number of logs to fetch

  • :skip (Integer) —

    Number of logs to skip

Returns:

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

    GetActivityMonitor data, response status code and response headers



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/crimson-falcon/api/activity_monitor.rb', line 68

def get_activity_monitor_v3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActivityMonitor.get_activity_monitor_v3 ...'
  end
  # resource path
  local_var_path = '/saas-security/entities/monitor/v3'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'integration_id'] = opts[:'integration_id'] if !opts[:'integration_id'].nil?
  query_params[:'actor'] = opts[:'actor'] if !opts[:'actor'].nil?
  query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
  query_params[:'projection'] = opts[:'projection'] if !opts[:'projection'].nil?
  query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetActivityMonitor'

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

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