Class: DatadogAPIClient::V2::DeliveryPerformanceAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DeliveryPerformanceAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Send AI tool user activity.

See Also:



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

def create_ai_impact_user_activity(body, opts = {})
  create_ai_impact_user_activity_with_http_info(body, opts)
  nil
end

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

Send AI tool user activity.

Send daily AI coding tool activity for one or more users. Each entry records whether a user was active on a given day, along with the AI tools and models they used. An entry is stored once per tool, and sending the same user, day, and tool again overwrites the previous value.

Parameters:

Returns:

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

    nil, response status code and response headers



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/delivery_performance_api.rb', line 44

def create_ai_impact_user_activity_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryPerformanceAPI.create_ai_impact_user_activity ...'
  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 DeliveryPerformanceAPI.create_ai_impact_user_activity"
  end
  # resource path
  local_var_path = '/api/v2/ai_impact/user_activity'

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

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

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

Send a deployment event.

See Also:



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

def create_dora_deployment(body, opts = {})
  data, _status_code, _headers = create_dora_deployment_with_http_info(body, opts)
  data
end

#create_dora_deployment_with_http_info(body, opts = {}) ⇒ Array<(DORADeploymentResponse, Integer, Hash)>

Send a deployment event.

Use this API endpoint to provide deployment data.

This is necessary for:

  • Deployment Frequency
  • Change Lead Time
  • Change Failure Rate
  • Failed Deployment Recovery Time

Parameters:

Returns:

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

    DORADeploymentResponse data, response status code and response headers



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
165
166
167
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 117

def create_dora_deployment_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryPerformanceAPI.create_dora_deployment ...'
  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 DeliveryPerformanceAPI.create_dora_deployment"
  end
  # resource path
  local_var_path = '/api/v2/dora/deployment'

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

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

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

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

Send an incident event.

See Also:



172
173
174
175
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 172

def create_dora_failure(body, opts = {})
  data, _status_code, _headers = create_dora_failure_with_http_info(body, opts)
  data
end

#create_dora_failure_with_http_info(body, opts = {}) ⇒ Array<(DORAFailureResponse, Integer, Hash)>

Send an incident event.

Use this API endpoint to provide incident data for DORA Metrics. Note that change failure rate and failed deployment recovery time are computed from change failures detected on deployments, not from incident events sent through this endpoint. Tracking incidents gives a side-by-side view of how failed deployments translate into real-world incidents, including their severity and frequency.

Parameters:

Returns:

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

    DORAFailureResponse data, response status code and response headers



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
228
229
230
231
232
233
234
235
236
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 186

def create_dora_failure_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryPerformanceAPI.create_dora_failure ...'
  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 DeliveryPerformanceAPI.create_dora_failure"
  end
  # resource path
  local_var_path = '/api/v2/dora/failure'

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

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

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

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

Send an incident event (legacy).

See Also:



241
242
243
244
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 241

def create_dora_incident(body, opts = {})
  data, _status_code, _headers = create_dora_incident_with_http_info(body, opts)
  data
end

#create_dora_incident_with_http_info(body, opts = {}) ⇒ Array<(DORAFailureResponse, Integer, Hash)>

Deprecated.

This API is deprecated.

Send an incident event (legacy).

Note: This endpoint is deprecated. Please use /api/v2/dora/failure instead.

Use this API endpoint to provide incident data. Tracking incidents gives a side-by-side view of how failed deployments translate into real-world incidents.

Parameters:

Returns:

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

    DORAFailureResponse data, response status code and response headers



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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 258

def create_dora_incident_with_http_info(body, opts = {})
  warn "[DEPRECATION] `CreateDORAIncident` is deprecated."

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryPerformanceAPI.create_dora_incident ...'
  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 DeliveryPerformanceAPI.create_dora_incident"
  end
  # resource path
  local_var_path = '/api/v2/dora/incident'

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

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

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

#delete_dora_deployment(deployment_id, opts = {}) ⇒ Object

Delete a deployment event.

See Also:



314
315
316
317
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 314

def delete_dora_deployment(deployment_id, opts = {})
  delete_dora_deployment_with_http_info(deployment_id, opts)
  nil
end

#delete_dora_deployment_with_http_info(deployment_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a deployment event.

Use this API endpoint to delete a deployment event.

Parameters:

  • deployment_id (String) —

    The ID of the deployment event to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 326

def delete_dora_deployment_with_http_info(deployment_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryPerformanceAPI.delete_dora_deployment ...'
  end
  # verify the required parameter 'deployment_id' is set
  if @api_client.config.client_side_validation && deployment_id.nil?
    fail ArgumentError, "Missing the required parameter 'deployment_id' when calling DeliveryPerformanceAPI.delete_dora_deployment"
  end
  # resource path
  local_var_path = '/api/v2/dora/deployment/{deployment_id}'.sub('{deployment_id}', CGI.escape(deployment_id.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, :AuthZ]

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

#delete_dora_failure(failure_id, opts = {}) ⇒ Object

Delete an incident event.

See Also:



379
380
381
382
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 379

def delete_dora_failure(failure_id, opts = {})
  delete_dora_failure_with_http_info(failure_id, opts)
  nil
end

#delete_dora_failure_with_http_info(failure_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an incident event.

Use this API endpoint to delete an incident event.

Parameters:

  • failure_id (String) —

    The ID of the incident event to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
432
433
434
435
436
437
438
439
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 391

def delete_dora_failure_with_http_info(failure_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryPerformanceAPI.delete_dora_failure ...'
  end
  # verify the required parameter 'failure_id' is set
  if @api_client.config.client_side_validation && failure_id.nil?
    fail ArgumentError, "Missing the required parameter 'failure_id' when calling DeliveryPerformanceAPI.delete_dora_failure"
  end
  # resource path
  local_var_path = '/api/v2/dora/failure/{failure_id}'.sub('{failure_id}', CGI.escape(failure_id.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, :AuthZ]

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

#get_dora_deployment(deployment_id, opts = {}) ⇒ Object

Get a deployment event.

See Also:



444
445
446
447
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 444

def get_dora_deployment(deployment_id, opts = {})
  data, _status_code, _headers = get_dora_deployment_with_http_info(deployment_id, opts)
  data
end

#get_dora_deployment_with_http_info(deployment_id, opts = {}) ⇒ Array<(DORADeploymentFetchResponse, Integer, Hash)>

Get a deployment event.

Use this API endpoint to get a deployment event.

Parameters:

  • deployment_id (String) —

    The ID of the deployment event.

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

    the optional parameters

Returns:

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

    DORADeploymentFetchResponse data, response status code and response headers



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 456

def get_dora_deployment_with_http_info(deployment_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryPerformanceAPI.get_dora_deployment ...'
  end
  # verify the required parameter 'deployment_id' is set
  if @api_client.config.client_side_validation && deployment_id.nil?
    fail ArgumentError, "Missing the required parameter 'deployment_id' when calling DeliveryPerformanceAPI.get_dora_deployment"
  end
  # resource path
  local_var_path = '/api/v2/dora/deployments/{deployment_id}'.sub('{deployment_id}', CGI.escape(deployment_id.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] || 'DORADeploymentFetchResponse'

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

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

#get_dora_failure(failure_id, opts = {}) ⇒ Object

Get an incident event.

See Also:



509
510
511
512
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 509

def get_dora_failure(failure_id, opts = {})
  data, _status_code, _headers = get_dora_failure_with_http_info(failure_id, opts)
  data
end

#get_dora_failure_with_http_info(failure_id, opts = {}) ⇒ Array<(DORAFailureFetchResponse, Integer, Hash)>

Get an incident event.

Use this API endpoint to get an incident event.

Parameters:

  • failure_id (String) —

    The ID of the incident event.

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

    the optional parameters

Returns:

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

    DORAFailureFetchResponse data, response status code and response headers



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 521

def get_dora_failure_with_http_info(failure_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryPerformanceAPI.get_dora_failure ...'
  end
  # verify the required parameter 'failure_id' is set
  if @api_client.config.client_side_validation && failure_id.nil?
    fail ArgumentError, "Missing the required parameter 'failure_id' when calling DeliveryPerformanceAPI.get_dora_failure"
  end
  # resource path
  local_var_path = '/api/v2/dora/failures/{failure_id}'.sub('{failure_id}', CGI.escape(failure_id.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] || 'DORAFailureFetchResponse'

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

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

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

Get a list of deployment events.

See Also:



574
575
576
577
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 574

def list_dora_deployments(body, opts = {})
  data, _status_code, _headers = list_dora_deployments_with_http_info(body, opts)
  data
end

#list_dora_deployments_with_http_info(body, opts = {}) ⇒ Array<(DORADeploymentsListResponse, Integer, Hash)>

Get a list of deployment events.

Use this API endpoint to get a list of deployment events.

Parameters:

Returns:

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

    DORADeploymentsListResponse data, response status code and response headers



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 586

def list_dora_deployments_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryPerformanceAPI.list_dora_deployments ...'
  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 DeliveryPerformanceAPI.list_dora_deployments"
  end
  # resource path
  local_var_path = '/api/v2/dora/deployments'

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

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

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

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

Get a list of incident events.

See Also:



641
642
643
644
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 641

def list_dora_failures(body, opts = {})
  data, _status_code, _headers = list_dora_failures_with_http_info(body, opts)
  data
end

#list_dora_failures_with_http_info(body, opts = {}) ⇒ Array<(DORAFailuresListResponse, Integer, Hash)>

Get a list of incident events.

Use this API endpoint to get a list of incident events.

Parameters:

Returns:

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

    DORAFailuresListResponse data, response status code and response headers



653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 653

def list_dora_failures_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryPerformanceAPI.list_dora_failures ...'
  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 DeliveryPerformanceAPI.list_dora_failures"
  end
  # resource path
  local_var_path = '/api/v2/dora/failures'

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

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

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

#patch_dora_deployment(deployment_id, body, opts = {}) ⇒ Object

Mark a deployment as failed by ID.

See Also:



708
709
710
711
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 708

def patch_dora_deployment(deployment_id, body, opts = {})
  patch_dora_deployment_with_http_info(deployment_id, body, opts)
  nil
end

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

Mark a deployment as failed by version.

See Also:



780
781
782
783
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 780

def patch_dora_deployment_by_version(body, opts = {})
  patch_dora_deployment_by_version_with_http_info(body, opts)
  nil
end

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

Mark a deployment as failed by version.

Update a deployment's change failure status, identifying the deployment by its service, environment, and version instead of its ID. Use this to mark a deployment as a change failure or back to stable. You can optionally include remediation details to enable failed deployment recovery time calculation. If multiple deployments match the given service, environment, and version, the most recently finished one is updated.

Parameters:

Returns:

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

    nil, response status code and response headers



792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 792

def patch_dora_deployment_by_version_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryPerformanceAPI.patch_dora_deployment_by_version ...'
  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 DeliveryPerformanceAPI.patch_dora_deployment_by_version"
  end
  # resource path
  local_var_path = '/api/v2/dora/deployments'

  # 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 => :patch_dora_deployment_by_version,
    :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: DeliveryPerformanceAPI#patch_dora_deployment_by_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Mark a deployment as failed by ID.

Update a deployment's change failure status. Use this to mark a deployment as a change failure or back to stable. You can optionally include remediation details to enable failed deployment recovery time calculation.

Parameters:

  • deployment_id (String) —

    The ID of the deployment event.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/datadog_api_client/v2/api/delivery_performance_api.rb', line 721

def patch_dora_deployment_with_http_info(deployment_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryPerformanceAPI.patch_dora_deployment ...'
  end
  # verify the required parameter 'deployment_id' is set
  if @api_client.config.client_side_validation && deployment_id.nil?
    fail ArgumentError, "Missing the required parameter 'deployment_id' when calling DeliveryPerformanceAPI.patch_dora_deployment"
  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 DeliveryPerformanceAPI.patch_dora_deployment"
  end
  # resource path
  local_var_path = '/api/v2/dora/deployments/{deployment_id}'.sub('{deployment_id}', CGI.escape(deployment_id.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(['*/*'])
  # 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 => :patch_dora_deployment,
    :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: DeliveryPerformanceAPI#patch_dora_deployment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end