Class: DatadogAPIClient::V1::DowntimesAPI
- Inherits:
-
Object
- Object
- DatadogAPIClient::V1::DowntimesAPI
- Defined in:
- lib/datadog_api_client/v1/api/downtimes_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#cancel_downtime(downtime_id, opts = {}) ⇒ Object
Cancel a downtime.
-
#cancel_downtime_with_http_info(downtime_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
-
#cancel_downtimes_by_scope(body, opts = {}) ⇒ Object
Cancel downtimes by scope.
-
#cancel_downtimes_by_scope_with_http_info(body, opts = {}) ⇒ Array<(CanceledDowntimesIds, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
-
#create_downtime(body, opts = {}) ⇒ Object
Schedule a downtime.
-
#create_downtime_with_http_info(body, opts = {}) ⇒ Array<(Downtime, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
-
#get_downtime(downtime_id, opts = {}) ⇒ Object
Get a downtime.
-
#get_downtime_with_http_info(downtime_id, opts = {}) ⇒ Array<(Downtime, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
-
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ DowntimesAPI
constructor
A new instance of DowntimesAPI.
-
#list_downtimes(opts = {}) ⇒ Object
Get all downtimes.
-
#list_downtimes_with_http_info(opts = {}) ⇒ Array<(Array<Downtime>, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
-
#list_monitor_downtimes(monitor_id, opts = {}) ⇒ Object
Get active downtimes for a monitor.
-
#list_monitor_downtimes_with_http_info(monitor_id, opts = {}) ⇒ Array<(Array<Downtime>, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
-
#update_downtime(downtime_id, body, opts = {}) ⇒ Object
Update a downtime.
-
#update_downtime_with_http_info(downtime_id, body, opts = {}) ⇒ Array<(Downtime, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
Constructor Details
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ DowntimesAPI
Returns a new instance of DowntimesAPI.
22 23 24 |
# File 'lib/datadog_api_client/v1/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/v1/api/downtimes_api.rb', line 20 def api_client @api_client end |
Instance Method Details
#cancel_downtime(downtime_id, opts = {}) ⇒ Object
Cancel a downtime.
29 30 31 32 |
# File 'lib/datadog_api_client/v1/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)>
This API is deprecated.
Cancel a downtime.
Cancel a downtime. Note: This endpoint has been deprecated. Please use v2 endpoints.
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 |
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 43 def cancel_downtime_with_http_info(downtime_id, opts = {}) warn "[DEPRECATION] `CancelDowntime` is deprecated." 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/v1/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] = 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 => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, ) 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 |
#cancel_downtimes_by_scope(body, opts = {}) ⇒ Object
Cancel downtimes by scope.
97 98 99 100 |
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 97 def cancel_downtimes_by_scope(body, opts = {}) data, _status_code, _headers = cancel_downtimes_by_scope_with_http_info(body, opts) data end |
#cancel_downtimes_by_scope_with_http_info(body, opts = {}) ⇒ Array<(CanceledDowntimesIds, Integer, Hash)>
This API is deprecated.
Cancel downtimes by scope.
Delete all downtimes that match the scope of ‘X`. Note: This only interacts with Downtimes created using v1 endpoints. This endpoint has been deprecated and will not be replaced. Please use v2 endpoints to find and cancel downtimes.
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 159 160 161 162 |
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 111 def cancel_downtimes_by_scope_with_http_info(body, opts = {}) warn "[DEPRECATION] `CancelDowntimesByScope` is deprecated." if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DowntimesAPI.cancel_downtimes_by_scope ...' 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.cancel_downtimes_by_scope" end # resource path local_var_path = '/api/v1/downtime/cancel/by_scope' # 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] || 'CanceledDowntimesIds' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :cancel_downtimes_by_scope, :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 => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DowntimesAPI#cancel_downtimes_by_scope\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_downtime(body, opts = {}) ⇒ Object
Schedule a downtime.
167 168 169 170 |
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 167 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<(Downtime, Integer, Hash)>
This API is deprecated.
Schedule a downtime.
Schedule a downtime. Note: This endpoint has been deprecated. Please use v2 endpoints.
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 228 229 230 231 232 |
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 181 def create_downtime_with_http_info(body, opts = {}) warn "[DEPRECATION] `CreateDowntime` is deprecated." 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/v1/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] || 'Downtime' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = 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 => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, ) 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.
237 238 239 240 |
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 237 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<(Downtime, Integer, Hash)>
This API is deprecated.
Get a downtime.
Get downtime detail by ‘downtime_id`. Note: This endpoint has been deprecated. Please use v2 endpoints.
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 294 295 296 297 298 299 300 |
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 251 def get_downtime_with_http_info(downtime_id, opts = {}) warn "[DEPRECATION] `GetDowntime` is deprecated." 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/v1/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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Downtime' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = 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 => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, ) 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.
305 306 307 308 |
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 305 def list_downtimes(opts = {}) data, _status_code, _headers = list_downtimes_with_http_info(opts) data end |
#list_downtimes_with_http_info(opts = {}) ⇒ Array<(Array<Downtime>, Integer, Hash)>
This API is deprecated.
Get all downtimes.
Get all scheduled downtimes. Note: This endpoint has been deprecated. Please use v2 endpoints.
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 360 361 362 363 364 365 366 367 |
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 320 def list_downtimes_with_http_info(opts = {}) warn "[DEPRECATION] `ListDowntimes` is deprecated." if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DowntimesAPI.list_downtimes ...' end # resource path local_var_path = '/api/v1/downtime' # query parameters query_params = opts[:query_params] || {} query_params[:'current_only'] = opts[:'current_only'] if !opts[:'current_only'].nil? query_params[:'with_creator'] = opts[:'with_creator'] if !opts[:'with_creator'].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] || 'Array<Downtime>' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = 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 => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, ) 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_monitor_downtimes(monitor_id, opts = {}) ⇒ Object
Get active downtimes for a monitor.
372 373 374 375 |
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 372 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<(Array<Downtime>, Integer, Hash)>
This API is deprecated.
Get active downtimes for a monitor.
Get all active v1 downtimes for the specified monitor. Note: This endpoint has been deprecated. Please use v2 endpoints.
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 432 433 434 435 |
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 386 def list_monitor_downtimes_with_http_info(monitor_id, opts = {}) warn "[DEPRECATION] `ListMonitorDowntimes` is deprecated." 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/v1/monitor/{monitor_id}/downtimes'.sub('{monitor_id}', CGI.escape(monitor_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] || 'Array<Downtime>' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = 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 => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, ) 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 |
#update_downtime(downtime_id, body, opts = {}) ⇒ Object
Update a downtime.
440 441 442 443 |
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 440 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<(Downtime, Integer, Hash)>
This API is deprecated.
Update a downtime.
Update a single downtime by ‘downtime_id`. Note: This endpoint has been deprecated. Please use v2 endpoints.
455 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 505 506 507 508 509 510 |
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 455 def update_downtime_with_http_info(downtime_id, body, opts = {}) warn "[DEPRECATION] `UpdateDowntime` is deprecated." 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/v1/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] || 'Downtime' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = 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 => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, ) 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 |