Class: DatadogAPIClient::V2::OCIIntegrationAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of OCIIntegrationAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Create tenancy config.

See Also:



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

def create_tenancy_config(body, opts = {})
  data, _status_code, _headers = create_tenancy_config_with_http_info(body, opts)
  data
end

#create_tenancy_config_with_http_info(body, opts = {}) ⇒ Array<(TenancyConfig, Integer, Hash)>

Create tenancy config.

Create a new tenancy config to establish monitoring and data collection from your OCI environment. Requires OCI authentication credentials and tenancy details. Warning: Datadog recommends interacting with this endpoint only through the Datadog web UI to ensure all necessary OCI resources have been created and configured properly.

Parameters:

Returns:

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

    TenancyConfig data, response status code and response headers



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
95
96
97
 
# File 'lib/datadog_api_client/v2/api/oci_integration_api.rb', line 41

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OCIIntegrationAPI.create_tenancy_config ...'
  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 OCIIntegrationAPI.create_tenancy_config"
  end
  # resource path
  local_var_path = '/api/v2/integration/oci/tenancies'

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

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

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

#delete_tenancy_config(tenancy_ocid, opts = {}) ⇒ Object

Delete tenancy config.

See Also:



102
103
104
105
 
# File 'lib/datadog_api_client/v2/api/oci_integration_api.rb', line 102

def delete_tenancy_config(tenancy_ocid, opts = {})
  delete_tenancy_config_with_http_info(tenancy_ocid, opts)
  nil
end

#delete_tenancy_config_with_http_info(tenancy_ocid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete tenancy config.

Delete an existing tenancy config. This will stop all data collection from the specified OCI tenancy and remove the stored configuration. This operation cannot be undone.

Parameters:

  • tenancy_ocid (String) —

    The OCID of the tenancy config to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_tenancy_config_with_http_info(tenancy_ocid, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OCIIntegrationAPI.delete_tenancy_config ...'
  end
  # verify the required parameter 'tenancy_ocid' is set
  if @api_client.config.client_side_validation && tenancy_ocid.nil?
    fail ArgumentError, "Missing the required parameter 'tenancy_ocid' when calling OCIIntegrationAPI.delete_tenancy_config"
  end
  # resource path
  local_var_path = '/api/v2/integration/oci/tenancies/{tenancy_ocid}'.sub('{tenancy_ocid}', CGI.escape(tenancy_ocid.to_s).gsub('%2F', '/'))

  # 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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#get_tenancy_config(tenancy_ocid, opts = {}) ⇒ Object

Get tenancy config.

See Also:



167
168
169
170
 
# File 'lib/datadog_api_client/v2/api/oci_integration_api.rb', line 167

def get_tenancy_config(tenancy_ocid, opts = {})
  data, _status_code, _headers = get_tenancy_config_with_http_info(tenancy_ocid, opts)
  data
end

#get_tenancy_config_with_http_info(tenancy_ocid, opts = {}) ⇒ Array<(TenancyConfig, Integer, Hash)>

Get tenancy config.

Get a single tenancy config object by its OCID. Returns detailed configuration including authentication credentials, enabled services, region settings, and collection preferences.

Parameters:

  • tenancy_ocid (String) —

    The OCID of the tenancy config to retrieve.

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

    the optional parameters

Returns:

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

    TenancyConfig data, response status code and response headers



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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/datadog_api_client/v2/api/oci_integration_api.rb', line 179

def get_tenancy_config_with_http_info(tenancy_ocid, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OCIIntegrationAPI.get_tenancy_config ...'
  end
  # verify the required parameter 'tenancy_ocid' is set
  if @api_client.config.client_side_validation && tenancy_ocid.nil?
    fail ArgumentError, "Missing the required parameter 'tenancy_ocid' when calling OCIIntegrationAPI.get_tenancy_config"
  end
  # resource path
  local_var_path = '/api/v2/integration/oci/tenancies/{tenancy_ocid}'.sub('{tenancy_ocid}', CGI.escape(tenancy_ocid.to_s).gsub('%2F', '/'))

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

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

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

#get_tenancy_configs(opts = {}) ⇒ Object

Get tenancy configs.

See Also:



232
233
234
235
 
# File 'lib/datadog_api_client/v2/api/oci_integration_api.rb', line 232

def get_tenancy_configs(opts = {})
  data, _status_code, _headers = get_tenancy_configs_with_http_info(opts)
  data
end

#get_tenancy_configs_with_http_info(opts = {}) ⇒ Array<(TenancyConfigList, Integer, Hash)>

Get tenancy configs.

Get a list of all configured OCI tenancy integrations. Returns basic information about each tenancy including authentication credentials, region settings, and collection preferences for metrics, logs, and resources.

Parameters:

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

    the optional parameters

Returns:

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

    TenancyConfigList data, response status code and response headers



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/datadog_api_client/v2/api/oci_integration_api.rb', line 243

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OCIIntegrationAPI.get_tenancy_configs ...'
  end
  # resource path
  local_var_path = '/api/v2/integration/oci/tenancies'

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

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

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

#list_tenancy_products(product_keys, opts = {}) ⇒ Object

List tenancy products.

See Also:



298
299
300
301
 
# File 'lib/datadog_api_client/v2/api/oci_integration_api.rb', line 298

def list_tenancy_products(product_keys, opts = {})
  data, _status_code, _headers = list_tenancy_products_with_http_info(product_keys, opts)
  data
end

#list_tenancy_products_with_http_info(product_keys, opts = {}) ⇒ Array<(TenancyProductsList, Integer, Hash)>

List tenancy products.

Lists the products for a given tenancy. Returns the enabled/disabled status of Datadog products (such as Cloud Security Posture Management) for specific OCI tenancies.

Parameters:

  • product_keys (String) —

    Comma-separated list of product keys to filter by.

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

    the optional parameters

Returns:

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

    TenancyProductsList data, response status code and response headers



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/datadog_api_client/v2/api/oci_integration_api.rb', line 310

def list_tenancy_products_with_http_info(product_keys, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OCIIntegrationAPI.list_tenancy_products ...'
  end
  # verify the required parameter 'product_keys' is set
  if @api_client.config.client_side_validation && product_keys.nil?
    fail ArgumentError, "Missing the required parameter 'product_keys' when calling OCIIntegrationAPI.list_tenancy_products"
  end
  # resource path
  local_var_path = '/api/v2/integration/oci/products'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'productKeys'] = product_keys

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

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

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

#update_tenancy_config(tenancy_ocid, body, opts = {}) ⇒ Object

Update tenancy config.

See Also:



364
365
366
367
 
# File 'lib/datadog_api_client/v2/api/oci_integration_api.rb', line 364

def update_tenancy_config(tenancy_ocid, body, opts = {})
  data, _status_code, _headers = update_tenancy_config_with_http_info(tenancy_ocid, body, opts)
  data
end

#update_tenancy_config_with_http_info(tenancy_ocid, body, opts = {}) ⇒ Array<(TenancyConfig, Integer, Hash)>

Update tenancy config.

Update an existing tenancy config. You can modify authentication credentials, enable/disable collection types, update service filters, and change region settings. Warning: We recommend using the Datadog web UI to avoid unintended update effects.

Parameters:

  • tenancy_ocid (String) —

    The OCID of the tenancy config to update.

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

    the optional parameters

Returns:

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

    TenancyConfig data, response status code and response headers



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/datadog_api_client/v2/api/oci_integration_api.rb', line 377

def update_tenancy_config_with_http_info(tenancy_ocid, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OCIIntegrationAPI.update_tenancy_config ...'
  end
  # verify the required parameter 'tenancy_ocid' is set
  if @api_client.config.client_side_validation && tenancy_ocid.nil?
    fail ArgumentError, "Missing the required parameter 'tenancy_ocid' when calling OCIIntegrationAPI.update_tenancy_config"
  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 OCIIntegrationAPI.update_tenancy_config"
  end
  # resource path
  local_var_path = '/api/v2/integration/oci/tenancies/{tenancy_ocid}'.sub('{tenancy_ocid}', CGI.escape(tenancy_ocid.to_s).gsub('%2F', '/'))

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

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

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