Class: SmplkitGeneratedClient::Audit::SearchApi

Inherits:
Object
  • Object
show all
Defined in:
lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/search_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SearchApi

Returns a new instance of SearchApi.



19
20
21
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/search_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/search_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#search_events(event_search_request, opts = {}) ⇒ EventSearchResponse

Search Events Search audit events with column filters and an optional JSON Logic expression. Without a JSON Logic ‘filter`: behaves like `GET /api/v1/events` with the same column filters. With a JSON Logic `filter`: the search is silently capped to the last 30 days by `occurred_at` (intersected with any explicit `filter` the caller supplied), the column filters narrow the candidate set in SQL, and the JSON Logic expression runs in memory against each candidate row using the same `json-logic-qubit` evaluator the forwarder pipeline uses. Up to 50,000 rows are scanned per request; the response’s ‘meta.scan` block reports the scan stats so a selective filter doesn’t look like "0 matches" when the truth is "ceiling reached."

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/search_api.rb', line 27

def search_events(event_search_request, opts = {})
  data, _status_code, _headers = search_events_with_http_info(event_search_request, opts)
  data
end

#search_events_with_http_info(event_search_request, opts = {}) ⇒ Array<(EventSearchResponse, Integer, Hash)>

Search Events Search audit events with column filters and an optional JSON Logic expression. Without a JSON Logic &#x60;filter&#x60;: behaves like &#x60;GET /api/v1/events&#x60; with the same column filters. With a JSON Logic &#x60;filter&#x60;: the search is silently capped to the last 30 days by &#x60;occurred_at&#x60; (intersected with any explicit &#x60;filter&#x60; the caller supplied), the column filters narrow the candidate set in SQL, and the JSON Logic expression runs in memory against each candidate row using the same &#x60;json-logic-qubit&#x60; evaluator the forwarder pipeline uses. Up to 50,000 rows are scanned per request; the response&#39;s &#x60;meta.scan&#x60; block reports the scan stats so a selective filter doesn&#39;t look like &quot;0 matches&quot; when the truth is &quot;ceiling reached.&quot;

Parameters:

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

    the optional parameters

Returns:

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

    EventSearchResponse data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/search_api.rb', line 37

def search_events_with_http_info(event_search_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SearchApi.search_events ...'
  end
  # verify the required parameter 'event_search_request' is set
  if @api_client.config.client_side_validation && event_search_request.nil?
    fail ArgumentError, "Missing the required parameter 'event_search_request' when calling SearchApi.search_events"
  end
  # resource path
  local_var_path = '/api/v1/search/events'

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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