Class: DatadogAPIClient::V2::IncidentsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = APIClient.default) ⇒ IncidentsAPI

Returns a new instance of IncidentsAPI.



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

def initialize(api_client = 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/incidents_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_incident(body, opts = {}) ⇒ IncidentResponse

Create an incident Create an incident.

Parameters:

  • body (IncidentCreateRequest) —

    Incident payload.

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

    the optional parameters

Returns:



30
31
32
33
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 30

def create_incident(body, opts = {})
  data, _status_code, _headers = create_incident_with_http_info(body, opts)
  data
end

#create_incident_with_http_info(body, opts = {}) ⇒ Array<(IncidentResponse, Integer, Hash)>

Create an incident Create an incident.

Parameters:

  • body (IncidentCreateRequest) —

    Incident payload.

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

    the optional parameters

Returns:

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

    IncidentResponse data, response status code and response headers



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

def create_incident_with_http_info(body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:create_incident)
    unstable_enabled = @api_client.config.unstable_operations[:create_incident]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "create_incident")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_incident"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.create_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 IncidentsAPI.create_incident"
  end
  # resource path
  local_var_path = '/api/v2/incidents'

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

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

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

#delete_incident(incident_id, opts = {}) ⇒ nil

Delete an existing incident Deletes an existing incident from the users organization.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

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

    the optional parameters

Returns:

  • (nil) 


105
106
107
108
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 105

def delete_incident(incident_id, opts = {})
  delete_incident_with_http_info(incident_id, opts)
  nil
end

#delete_incident_with_http_info(incident_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an existing incident Deletes an existing incident from the users organization.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
165
166
167
168
169
170
171
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 115

def delete_incident_with_http_info(incident_id, opts = {})

  if @api_client.config.unstable_operations.has_key?(:delete_incident)
    unstable_enabled = @api_client.config.unstable_operations[:delete_incident]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "delete_incident")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "delete_incident"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.delete_incident ...'
  end
  # verify the required parameter 'incident_id' is set
  if @api_client.config.client_side_validation && incident_id.nil?
    fail ArgumentError, "Missing the required parameter 'incident_id' when calling IncidentsAPI.delete_incident"
  end
  # resource path
  local_var_path = '/api/v2/incidents/{incident_id}'.sub('{' + 'incident_id' + '}', CGI.escape(incident_id.to_s))

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

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

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

#get_incident(incident_id, opts = {}) ⇒ IncidentResponse

Get the details of an incident Get the details of an incident by ‘incident_id`.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

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

    the optional parameters

Options Hash (opts):

  • :include (Array<IncidentRelatedObject>) —

    Specifies which types of related objects should be included in the response.

Returns:



179
180
181
182
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 179

def get_incident(incident_id, opts = {})
  data, _status_code, _headers = get_incident_with_http_info(incident_id, opts)
  data
end

#get_incident_with_http_info(incident_id, opts = {}) ⇒ Array<(IncidentResponse, Integer, Hash)>

Get the details of an incident Get the details of an incident by &#x60;incident_id&#x60;.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

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

    the optional parameters

Options Hash (opts):

  • :include (Array<IncidentRelatedObject>) —

    Specifies which types of related objects should be included in the response.

Returns:

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

    IncidentResponse data, response status code and response headers



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
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 190

def get_incident_with_http_info(incident_id, opts = {})

  if @api_client.config.unstable_operations.has_key?(:get_incident)
    unstable_enabled = @api_client.config.unstable_operations[:get_incident]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "get_incident")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "get_incident"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.get_incident ...'
  end
  # verify the required parameter 'incident_id' is set
  if @api_client.config.client_side_validation && incident_id.nil?
    fail ArgumentError, "Missing the required parameter 'incident_id' when calling IncidentsAPI.get_incident"
  end
  # resource path
  local_var_path = '/api/v2/incidents/{incident_id}'.sub('{' + 'incident_id' + '}', CGI.escape(incident_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?

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

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

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

#list_incidents(opts = {}) ⇒ IncidentsResponse

Get a list of incidents Get all incidents for the user’s organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include (Array<IncidentRelatedObject>) —

    Specifies which types of related objects should be included in the response.

  • :page_size (Integer) —

    Size for a given page. (default to 10)

  • :page_offset (Integer) —

    Specific offset to use as the beginning of the returned page. (default to 0)

Returns:



256
257
258
259
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 256

def list_incidents(opts = {})
  data, _status_code, _headers = list_incidents_with_http_info(opts)
  data
end

#list_incidents_with_http_info(opts = {}) ⇒ Array<(IncidentsResponse, Integer, Hash)>

Get a list of incidents Get all incidents for the user&#39;s organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include (Array<IncidentRelatedObject>) —

    Specifies which types of related objects should be included in the response.

  • :page_size (Integer) —

    Size for a given page.

  • :page_offset (Integer) —

    Specific offset to use as the beginning of the returned page.

Returns:

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

    IncidentsResponse data, response status code and response headers



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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 268

def list_incidents_with_http_info(opts = {})

  if @api_client.config.unstable_operations.has_key?(:list_incidents)
    unstable_enabled = @api_client.config.unstable_operations[:list_incidents]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "list_incidents")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_incidents"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.list_incidents ...'
  end
  # resource path
  local_var_path = '/api/v2/incidents'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_offset'].nil?

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

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

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

#update_incident(incident_id, body, opts = {}) ⇒ IncidentResponse

Update an existing incident Updates an incident. Provide only the attributes that should be updated as this request is a partial update.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

  • body (IncidentUpdateRequest) —

    Incident Payload.

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

    the optional parameters

Returns:



331
332
333
334
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 331

def update_incident(incident_id, body, opts = {})
  data, _status_code, _headers = update_incident_with_http_info(incident_id, body, opts)
  data
end

#update_incident_with_http_info(incident_id, body, opts = {}) ⇒ Array<(IncidentResponse, Integer, Hash)>

Update an existing incident Updates an incident. Provide only the attributes that should be updated as this request is a partial update.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

  • body (IncidentUpdateRequest) —

    Incident Payload.

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

    the optional parameters

Returns:

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

    IncidentResponse data, response status code and response headers



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
375
376
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
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 342

def update_incident_with_http_info(incident_id, body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:update_incident)
    unstable_enabled = @api_client.config.unstable_operations[:update_incident]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "update_incident")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_incident"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.update_incident ...'
  end
  # verify the required parameter 'incident_id' is set
  if @api_client.config.client_side_validation && incident_id.nil?
    fail ArgumentError, "Missing the required parameter 'incident_id' when calling IncidentsAPI.update_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 IncidentsAPI.update_incident"
  end
  # resource path
  local_var_path = '/api/v2/incidents/{incident_id}'.sub('{' + 'incident_id' + '}', CGI.escape(incident_id.to_s))

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

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

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