Class: Falcon::CloudSecurityRisks

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CloudSecurityRisks

Returns a new instance of CloudSecurityRisks.



35
36
37
 
# File 'lib/crimson-falcon/api/cloud_security_risks.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/cloud_security_risks.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#cloud_security_timeline_risks_enriched(id, opts = {}) ⇒ RestGetEnrichedTimelineResponse

Returns the enriched asset timeline. Rate limited to 500 requests per minute per CID. Exceeding this limit returns HTTP 429 (Too Many Requests).

Parameters:

  • id (String) —

    The GCRN (Global Cloud Resource Name) of the asset

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

    the optional parameters

Returns:



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

def cloud_security_timeline_risks_enriched(id, opts = {})
  data, _status_code, _headers = cloud_security_timeline_risks_enriched_with_http_info(id, opts)
  data
end

#cloud_security_timeline_risks_enriched_with_http_info(id, opts = {}) ⇒ Array<(RestGetEnrichedTimelineResponse, Integer, Hash)>

Returns the enriched asset timeline. Rate limited to 500 requests per minute per CID. Exceeding this limit returns HTTP 429 (Too Many Requests).

Parameters:

  • id (String) —

    The GCRN (Global Cloud Resource Name) of the asset

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

    the optional parameters

Returns:



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
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/crimson-falcon/api/cloud_security_risks.rb', line 51

def cloud_security_timeline_risks_enriched_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudSecurityRisks.cloud_security_timeline_risks_enriched ...'
  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 CloudSecurityRisks.cloud_security_timeline_risks_enriched"
  end
  # resource path
  local_var_path = '/cloud-security-timeline/entities/cloud-risks-enriched-timeline/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(['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] || 'RestGetEnrichedTimelineResponse'

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

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