Class: DatadogAPIClient::V2::StaticAnalysisAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/static_analysis_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ StaticAnalysisAPI

Returns a new instance of StaticAnalysisAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/static_analysis_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/static_analysis_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_sca_resolve_vulnerable_symbols(body, opts = {}) ⇒ Object

POST request to resolve vulnerable symbols.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/static_analysis_api.rb', line 29

def create_sca_resolve_vulnerable_symbols(body, opts = {})
  data, _status_code, _headers = create_sca_resolve_vulnerable_symbols_with_http_info(body, opts)
  data
end

#create_sca_resolve_vulnerable_symbols_with_http_info(body, opts = {}) ⇒ Array<(ResolveVulnerableSymbolsResponse, Integer, Hash)>

POST request to resolve vulnerable symbols.

Parameters:

Returns:



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
89
90
91
92
93
94
 
# File 'lib/datadog_api_client/v2/api/static_analysis_api.rb', line 38

def create_sca_resolve_vulnerable_symbols_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_sca_resolve_vulnerable_symbols".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_sca_resolve_vulnerable_symbols")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_sca_resolve_vulnerable_symbols"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StaticAnalysisAPI.create_sca_resolve_vulnerable_symbols ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling StaticAnalysisAPI.create_sca_resolve_vulnerable_symbols"
  end
  # resource path
  local_var_path = '/api/v2/static-analysis-sca/vulnerabilities/resolve-vulnerable-symbols'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :create_sca_resolve_vulnerable_symbols,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StaticAnalysisAPI#create_sca_resolve_vulnerable_symbols\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_sca_result(body, opts = {}) ⇒ Object

Post dependencies for analysis.

See Also:



99
100
101
102
 
# File 'lib/datadog_api_client/v2/api/static_analysis_api.rb', line 99

def create_sca_result(body, opts = {})
  create_sca_result_with_http_info(body, opts)
  nil
end

#create_sca_result_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Post dependencies for analysis.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/datadog_api_client/v2/api/static_analysis_api.rb', line 108

def create_sca_result_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_sca_result".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_sca_result")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_sca_result"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StaticAnalysisAPI.create_sca_result ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling StaticAnalysisAPI.create_sca_result"
  end
  # resource path
  local_var_path = '/api/v2/static-analysis-sca/dependencies'

  # 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(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :create_sca_result,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StaticAnalysisAPI#create_sca_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end