Class: DatadogAPIClient::V2::DowntimesAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DowntimesAPI.



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

def api_client
  @api_client
end

Instance Method Details

#cancel_downtime(downtime_id, opts = {}) ⇒ Object

Cancel a downtime.

See Also:



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

def cancel_downtime(downtime_id, opts = {})
  cancel_downtime_with_http_info(downtime_id, opts)
  nil
end

#cancel_downtime_with_http_info(downtime_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Cancel a downtime.

Cancel a downtime.

Note: Downtimes canceled through the API are no longer active, but are retained for approximately two days before being permanently removed. The downtime may still appear in search results until it is permanently removed.

Parameters:

  • downtime_id (String) —

    ID of the downtime to cancel.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def cancel_downtime_with_http_info(downtime_id, opts = {})

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

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

Schedule a downtime.

See Also:



96
97
98
99
 
# File 'lib/datadog_api_client/v2/api/downtimes_api.rb', line 96

def create_downtime(body, opts = {})
  data, _status_code, _headers = create_downtime_with_http_info(body, opts)
  data
end

#create_downtime_with_http_info(body, opts = {}) ⇒ Array<(DowntimeResponse, Integer, Hash)>

Schedule a downtime.

Schedule a downtime.

Parameters:

  • body (DowntimeCreateRequest) —

    Schedule a downtime request body.

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

    the optional parameters

Returns:

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

    DowntimeResponse data, 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
 
# File 'lib/datadog_api_client/v2/api/downtimes_api.rb', line 108

def create_downtime_with_http_info(body, opts = {})

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

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

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

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

#get_downtime(downtime_id, opts = {}) ⇒ Object

Get a downtime.

See Also:



163
164
165
166
 
# File 'lib/datadog_api_client/v2/api/downtimes_api.rb', line 163

def get_downtime(downtime_id, opts = {})
  data, _status_code, _headers = get_downtime_with_http_info(downtime_id, opts)
  data
end

#get_downtime_with_http_info(downtime_id, opts = {}) ⇒ Array<(DowntimeResponse, Integer, Hash)>

Get a downtime.

Get downtime detail by ‘downtime_id`.

Parameters:

  • downtime_id (String) —

    ID of the downtime to fetch.

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of resource paths for related resources to include in the response. Supported resource paths are ‘created_by` and `monitor`.

Returns:

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

    DowntimeResponse data, response status code and response headers



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

def get_downtime_with_http_info(downtime_id, opts = {})

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] 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] || 'DowntimeResponse'

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

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

#list_downtimes(opts = {}) ⇒ Object

Get all downtimes.

See Also:



230
231
232
233
 
# File 'lib/datadog_api_client/v2/api/downtimes_api.rb', line 230

def list_downtimes(opts = {})
  data, _status_code, _headers = list_downtimes_with_http_info(opts)
  data
end

#list_downtimes_with_http_info(opts = {}) ⇒ Array<(ListDowntimesResponse, Integer, Hash)>

Get all downtimes.

Get all scheduled downtimes.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :current_only (Boolean) —

    Only return downtimes that are active when the request is made.

  • :include (String) —

    Comma-separated list of resource paths for related resources to include in the response. Supported resource paths are ‘created_by` and `monitor`.

  • :page_offset (Integer) —

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

  • :page_limit (Integer) —

    Maximum number of downtimes in the response.

Returns:

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

    ListDowntimesResponse data, response status code and response headers



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/downtimes_api.rb', line 245

def list_downtimes_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DowntimesAPI.list_downtimes ...'
  end
  # resource path
  local_var_path = '/api/v2/downtime'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'current_only'] = opts[:'current_only'] if !opts[:'current_only'].nil?
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
  query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_offset'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].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] || 'ListDowntimesResponse'

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

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

#list_downtimes_with_pagination(opts = {}) {|DowntimeResponseData| ... } ⇒ Object

Get all downtimes.

Provide a paginated version of #list_downtimes, returning all items.

To use it you need to use a block: list_downtimes_with_pagination { |item| p item }

Yields:



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/datadog_api_client/v2/api/downtimes_api.rb', line 302

def list_downtimes_with_pagination(opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "page_limit", 30)
    @api_client.set_attribute_from_path(api_version, opts, "page_limit", Integer, page_size)
    while true do
        response = list_downtimes(opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length < page_size
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "page_offset", Integer, @api_client.get_attribute_from_path(opts, "page_offset", 0) + page_size)
    end
end

#list_monitor_downtimes(monitor_id, opts = {}) ⇒ Object

Get active downtimes for a monitor.

See Also:



319
320
321
322
 
# File 'lib/datadog_api_client/v2/api/downtimes_api.rb', line 319

def list_monitor_downtimes(monitor_id, opts = {})
  data, _status_code, _headers = list_monitor_downtimes_with_http_info(monitor_id, opts)
  data
end

#list_monitor_downtimes_with_http_info(monitor_id, opts = {}) ⇒ Array<(MonitorDowntimeMatchResponse, Integer, Hash)>

Get active downtimes for a monitor.

Get all active downtimes for the specified monitor.

Parameters:

  • monitor_id (Integer) —

    The id of the monitor.

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

    the optional parameters

Options Hash (opts):

  • :page_offset (Integer) —

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

  • :page_limit (Integer) —

    Maximum number of downtimes in the response.

Returns:



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
375
376
377
378
379
380
381
382
383
 
# File 'lib/datadog_api_client/v2/api/downtimes_api.rb', line 333

def list_monitor_downtimes_with_http_info(monitor_id, opts = {})

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_offset'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].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] || 'MonitorDowntimeMatchResponse'

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

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

#list_monitor_downtimes_with_pagination(monitor_id, opts = {}) {|MonitorDowntimeMatchResponseData| ... } ⇒ Object

Get active downtimes for a monitor.

Provide a paginated version of #list_monitor_downtimes, returning all items.

To use it you need to use a block: list_monitor_downtimes_with_pagination { |item| p item }

Yields:



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/datadog_api_client/v2/api/downtimes_api.rb', line 392

def list_monitor_downtimes_with_pagination(monitor_id, opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "page_limit", 30)
    @api_client.set_attribute_from_path(api_version, opts, "page_limit", Integer, page_size)
    while true do
        response = list_monitor_downtimes(monitor_id, opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length < page_size
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "page_offset", Integer, @api_client.get_attribute_from_path(opts, "page_offset", 0) + page_size)
    end
end

#update_downtime(downtime_id, body, opts = {}) ⇒ Object

Update a downtime.

See Also:



409
410
411
412
 
# File 'lib/datadog_api_client/v2/api/downtimes_api.rb', line 409

def update_downtime(downtime_id, body, opts = {})
  data, _status_code, _headers = update_downtime_with_http_info(downtime_id, body, opts)
  data
end

#update_downtime_with_http_info(downtime_id, body, opts = {}) ⇒ Array<(DowntimeResponse, Integer, Hash)>

Update a downtime.

Update a downtime by ‘downtime_id`.

Parameters:

  • downtime_id (String) —

    ID of the downtime to update.

  • body (DowntimeUpdateRequest) —

    Update a downtime request body.

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

    the optional parameters

Returns:

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

    DowntimeResponse data, response status code and response headers



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/datadog_api_client/v2/api/downtimes_api.rb', line 422

def update_downtime_with_http_info(downtime_id, body, opts = {})

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

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

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