Class: DatadogAPIClient::V1::DowntimeRecurrence

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

Overview

An object defining the recurrence of the downtime.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



51
52
53
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 51

def additional_properties
  @additional_properties
end

#period ⇒ Object

How often to repeat as an integer. For example, to repeat every 3 days, select a type of ‘days` and a period of `3`.



26
27
28
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 26

def period
  @period
end

#rrule ⇒ Object

The ‘RRULE` standard for defining recurring events (**requires to set “type” to rrule**) For example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`. Most common `rrule` options from the [iCalendar Spec](tools.ietf.org/html/rfc5545) are supported.

Note: Attributes specifying the duration in ‘RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`). More examples available in this [downtime guide](docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api)



34
35
36
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 34

def rrule
  @rrule
end

#type ⇒ Object

The type of recurrence. Choose from ‘days`, `weeks`, `months`, `years`, `rrule`.



37
38
39
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 37

def type
  @type
end

#until_date ⇒ Object

The date at which the recurrence should end as a POSIX timestamp. ‘until_occurences` and `until_date` are mutually exclusive.



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

def until_date
  @until_date
end

#until_occurrences ⇒ Object

How many times the downtime is rescheduled. ‘until_occurences` and `until_date` are mutually exclusive.



45
46
47
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 45

def until_occurrences
  @until_occurrences
end

#week_days ⇒ Object

A list of week days to repeat on. Choose from ‘Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat` or `Sun`. Only applicable when type is weeks. First letter must be capitalized.



49
50
51
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 49

def week_days
  @week_days
end