Class: DatadogAPIClient::V2::CSMCoverageAnalysisAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of CSMCoverageAnalysisAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/csm_coverage_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/csm_coverage_analysis_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#get_csm_cloud_accounts_coverage_analysis(opts = {}) ⇒ Object

Get the CSM Cloud Accounts Coverage Analysis.

See Also:



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

def get_csm_cloud_accounts_coverage_analysis(opts = {})
  data, _status_code, _headers = get_csm_cloud_accounts_coverage_analysis_with_http_info(opts)
  data
end

#get_csm_cloud_accounts_coverage_analysis_with_http_info(opts = {}) ⇒ Array<(CsmCloudAccountsCoverageAnalysisResponse, Integer, Hash)>

Get the CSM Cloud Accounts Coverage Analysis.

Get the CSM Coverage Analysis of your Cloud Accounts. This is calculated based on the number of your Cloud Accounts that are scanned for security issues.

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/datadog_api_client/v2/api/csm_coverage_analysis_api.rb', line 42

def get_csm_cloud_accounts_coverage_analysis_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CSMCoverageAnalysisAPI.get_csm_cloud_accounts_coverage_analysis ...'
  end
  # resource path
  local_var_path = '/api/v2/csm/onboarding/coverage_analysis/cloud_accounts'

  # 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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :get_csm_cloud_accounts_coverage_analysis,
    :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::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CSMCoverageAnalysisAPI#get_csm_cloud_accounts_coverage_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_csm_hosts_and_containers_coverage_analysis(opts = {}) ⇒ Object

Get the CSM Hosts and Containers Coverage Analysis.

See Also:



91
92
93
94
 
# File 'lib/datadog_api_client/v2/api/csm_coverage_analysis_api.rb', line 91

def get_csm_hosts_and_containers_coverage_analysis(opts = {})
  data, _status_code, _headers = get_csm_hosts_and_containers_coverage_analysis_with_http_info(opts)
  data
end

#get_csm_hosts_and_containers_coverage_analysis_with_http_info(opts = {}) ⇒ Array<(CsmHostsAndContainersCoverageAnalysisResponse, Integer, Hash)>

Get the CSM Hosts and Containers Coverage Analysis.

Get the CSM Coverage Analysis of your Hosts and Containers. This is calculated based on the number of agents running on your Hosts and Containers with CSM feature(s) enabled.

Parameters:

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

    the optional parameters

Returns:



104
105
106
107
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
 
# File 'lib/datadog_api_client/v2/api/csm_coverage_analysis_api.rb', line 104

def get_csm_hosts_and_containers_coverage_analysis_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CSMCoverageAnalysisAPI.get_csm_hosts_and_containers_coverage_analysis ...'
  end
  # resource path
  local_var_path = '/api/v2/csm/onboarding/coverage_analysis/hosts_and_containers'

  # 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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :get_csm_hosts_and_containers_coverage_analysis,
    :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::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CSMCoverageAnalysisAPI#get_csm_hosts_and_containers_coverage_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_csm_serverless_coverage_analysis(opts = {}) ⇒ Object

Get the CSM Serverless Coverage Analysis.

See Also:



153
154
155
156
 
# File 'lib/datadog_api_client/v2/api/csm_coverage_analysis_api.rb', line 153

def get_csm_serverless_coverage_analysis(opts = {})
  data, _status_code, _headers = get_csm_serverless_coverage_analysis_with_http_info(opts)
  data
end

#get_csm_serverless_coverage_analysis_with_http_info(opts = {}) ⇒ Array<(CsmServerlessCoverageAnalysisResponse, Integer, Hash)>

Get the CSM Serverless Coverage Analysis.

Get the CSM Coverage Analysis of your Serverless Resources. This is calculated based on the number of agents running on your Serverless Resources with CSM feature(s) enabled.

Parameters:

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

    the optional parameters

Returns:



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/datadog_api_client/v2/api/csm_coverage_analysis_api.rb', line 166

def get_csm_serverless_coverage_analysis_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CSMCoverageAnalysisAPI.get_csm_serverless_coverage_analysis ...'
  end
  # resource path
  local_var_path = '/api/v2/csm/onboarding/coverage_analysis/serverless'

  # 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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :get_csm_serverless_coverage_analysis,
    :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::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CSMCoverageAnalysisAPI#get_csm_serverless_coverage_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end