Class: DatadogAPIClient::V1::DowntimeChild
- Inherits:
-
Object
- Object
- DatadogAPIClient::V1::DowntimeChild
- Includes:
- BaseGenericModel
- Defined in:
- lib/datadog_api_client/v1/models/downtime_child.rb
Overview
The downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.
Instance Attribute Summary collapse
-
#_end ⇒ Object
POSIX timestamp to end the downtime.
-
#active ⇒ Object
If a scheduled downtime currently exists.
-
#additional_properties ⇒ Object
Returns the value of attribute additional_properties.
-
#canceled ⇒ Object
If a scheduled downtime is canceled.
-
#creator_id ⇒ Object
readonly
User ID of the downtime creator.
-
#disabled ⇒ Object
If a downtime has been disabled.
-
#downtime_type ⇒ Object
readonly
‘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.
-
#id ⇒ Object
The downtime ID.
-
#message ⇒ Object
A message to include with notifications for this downtime.
-
#monitor_id ⇒ Object
A single monitor to which the downtime applies.
-
#monitor_tags ⇒ Object
A comma-separated list of monitor tags.
-
#mute_first_recovery_notification ⇒ Object
If the first recovery notification during a downtime should be muted.
-
#notify_end_states ⇒ Object
States for which ‘notify_end_types` sends out notifications for.
-
#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.
-
#parent_id ⇒ Object
ID of the parent Downtime.
-
#recurrence ⇒ Object
An object defining the recurrence of the downtime.
-
#scope ⇒ Object
The scope(s) to which the downtime applies and must be in ‘key:value` format.
-
#start ⇒ Object
POSIX timestamp to start the downtime.
-
#timezone ⇒ Object
The timezone in which to display the downtime’s start and end times in Datadog applications.
-
#updater_id ⇒ Object
readonly
ID of the last user that updated the downtime.
Method Summary
Methods included from BaseGenericModel
Instance Attribute Details
#_end ⇒ Object
POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it.
44 45 46 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 44 def _end @_end end |
#active ⇒ Object
If a scheduled downtime currently exists.
26 27 28 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 26 def active @active end |
#additional_properties ⇒ Object
Returns the value of attribute additional_properties.
96 97 98 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 96 def additional_properties @additional_properties end |
#canceled ⇒ Object
If a scheduled downtime is canceled.
29 30 31 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 29 def canceled @canceled end |
#creator_id ⇒ Object
User ID of the downtime creator.
32 33 34 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 32 def creator_id @creator_id end |
#disabled ⇒ Object
If a downtime has been disabled.
35 36 37 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 35 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.
40 41 42 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 40 def downtime_type @downtime_type end |
#id ⇒ Object
The downtime ID.
47 48 49 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 47 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.
51 52 53 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 51 def @message end |
#monitor_id ⇒ Object
A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors.
55 56 57 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 55 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`.
61 62 63 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 61 def @monitor_tags end |
#mute_first_recovery_notification ⇒ Object
If the first recovery notification during a downtime should be muted.
64 65 66 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 64 def mute_first_recovery_notification @mute_first_recovery_notification end |
#notify_end_states ⇒ Object
States for which ‘notify_end_types` sends out notifications for.
67 68 69 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 67 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.
73 74 75 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 73 def notify_end_types @notify_end_types end |
#parent_id ⇒ Object
ID of the parent Downtime.
76 77 78 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 76 def parent_id @parent_id end |
#recurrence ⇒ Object
An object defining the recurrence of the downtime.
79 80 81 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 79 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`).
84 85 86 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 84 def scope @scope end |
#start ⇒ Object
POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created.
88 89 90 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 88 def start @start end |
#timezone ⇒ Object
The timezone in which to display the downtime’s start and end times in Datadog applications.
91 92 93 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 91 def timezone @timezone end |
#updater_id ⇒ Object
ID of the last user that updated the downtime.
94 95 96 |
# File 'lib/datadog_api_client/v1/models/downtime_child.rb', line 94 def updater_id @updater_id end |