Class: DatadogAPIClient::V1::Downtime

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v1/models/downtime.rb

Overview

Downtiming gives you greater control over monitor notifications by allowing you to globally exclude scopes from alerting. Downtime settings, which can be scheduled with start and end times, prevent all alerting related to specified Datadog tags.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#_end ⇒ Object

POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it.



50
51
52
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 50

def _end
  @_end
end

#active ⇒ Object

If a scheduled downtime currently exists.



28
29
30
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 28

def active
  @active
end

#active_child ⇒ Object

The downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.



32
33
34
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 32

def active_child
  @active_child
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



102
103
104
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 102

def additional_properties
  @additional_properties
end

#canceled ⇒ Object

If a scheduled downtime is canceled.



35
36
37
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 35

def canceled
  @canceled
end

#creator_id ⇒ Object

User ID of the downtime creator.



38
39
40
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 38

def creator_id
  @creator_id
end

#disabled ⇒ Object

If a downtime has been disabled.



41
42
43
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 41

def disabled
  @disabled
end

#downtime_type ⇒ Object

‘0` for a downtime applied on `*` or all, `1` when the downtime is only scoped to hosts, or `2` when the downtime is scoped to anything but hosts.



46
47
48
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 46

def downtime_type
  @downtime_type
end

#id ⇒ Object

The downtime ID.



53
54
55
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 53

def id
  @id
end

#message ⇒ Object

A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same ‘@username` notation as events.



57
58
59
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 57

def message
  @message
end

#monitor_id ⇒ Object

A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors.



61
62
63
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 61

def monitor_id
  @monitor_id
end

#monitor_tags ⇒ Object

A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match ALL provided monitor tags. For example, ‘service:postgres` AND `team:frontend`.



67
68
69
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 67

def monitor_tags
  @monitor_tags
end

#mute_first_recovery_notification ⇒ Object

If the first recovery notification during a downtime should be muted.



70
71
72
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 70

def mute_first_recovery_notification
  @mute_first_recovery_notification
end

#notify_end_states ⇒ Object

States for which ‘notify_end_types` sends out notifications for.



73
74
75
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 73

def notify_end_states
  @notify_end_states
end

#notify_end_types ⇒ Object

If set, notifies if a monitor is in an alert-worthy state (‘ALERT`, `WARNING`, or `NO DATA`) when this downtime expires or is canceled. Applied to monitors that change states during the downtime (such as from `OK` to `ALERT`, `WARNING`, or `NO DATA`), and to monitors that already have an alert-worthy state when downtime begins.



79
80
81
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 79

def notify_end_types
  @notify_end_types
end

#parent_id ⇒ Object

ID of the parent Downtime.



82
83
84
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 82

def parent_id
  @parent_id
end

#recurrence ⇒ Object

An object defining the recurrence of the downtime.



85
86
87
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 85

def recurrence
  @recurrence
end

#scope ⇒ Object

The scope(s) to which the downtime applies and must be in ‘key:value` format. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` AND `env:prod`).



90
91
92
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 90

def scope
  @scope
end

#start ⇒ Object

POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created.



94
95
96
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 94

def start
  @start
end

#timezone ⇒ Object

The timezone in which to display the downtime’s start and end times in Datadog applications.



97
98
99
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 97

def timezone
  @timezone
end

#updater_id ⇒ Object

ID of the last user that updated the downtime.



100
101
102
 
# File 'lib/datadog_api_client/v1/models/downtime.rb', line 100

def updater_id
  @updater_id
end