class DatadogAPIClient::V1::DowntimeRecurrence

An object defining the recurrence of the downtime.

Attributes

period[RW]

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

rrule[RW]

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/supress-alert-with-downtimes/?tab=api)

type[RW]

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

until_date[RW]

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

until_occurrences[RW]

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

week_days[RW]

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.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 53
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 41
def self.attribute_map
  {
    :'period' => :'period',
    :'rrule' => :'rrule',
    :'type' => :'type',
    :'until_date' => :'until_date',
    :'until_occurrences' => :'until_occurrences',
    :'week_days' => :'week_days'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 190
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 79
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::DowntimeRecurrence` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V1::DowntimeRecurrence`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'period')
    self.period = attributes[:'period']
  end

  if attributes.key?(:'rrule')
    self.rrule = attributes[:'rrule']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'until_date')
    self.until_date = attributes[:'until_date']
  end

  if attributes.key?(:'until_occurrences')
    self.until_occurrences = attributes[:'until_occurrences']
  end

  if attributes.key?(:'week_days')
    if (value = attributes[:'week_days']).is_a?(Array)
      self.week_days = value
    end
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 70
def self.openapi_nullable
  Set.new([
    :'until_date',
    :'until_occurrences',
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 58
def self.openapi_types
  {
    :'period' => :'Integer',
    :'rrule' => :'String',
    :'type' => :'String',
    :'until_date' => :'Integer',
    :'until_occurrences' => :'Integer',
    :'week_days' => :'Array<String>'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 164
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      period == o.period &&
      rrule == o.rrule &&
      type == o.type &&
      until_date == o.until_date &&
      until_occurrences == o.until_occurrences &&
      week_days == o.week_days
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 220
def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when :Array
    # generic array, return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = DatadogAPIClient::V1.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 294
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 197
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 177
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 183
def hash
  [period, rrule, type, until_date, until_occurrences, week_days].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 121
def list_invalid_properties
  invalid_properties = Array.new
  if !@period.nil? && @period > 2147483647
    invalid_properties.push('invalid value for "period", must be smaller than or equal to 2147483647.')
  end

  if !@until_occurrences.nil? && @until_occurrences > 2147483647
    invalid_properties.push('invalid value for "until_occurrences", must be smaller than or equal to 2147483647.')
  end

  invalid_properties
end
period=(period) click to toggle source

Custom attribute writer method with validation @param [Object] period Value to be assigned

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 144
def period=(period)
  if !period.nil? && period > 2147483647
    fail ArgumentError, 'invalid value for "period", must be smaller than or equal to 2147483647.'
  end

  @period = period
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 270
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 276
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 264
def to_s
  to_hash.to_s
end
until_occurrences=(until_occurrences) click to toggle source

Custom attribute writer method with validation @param [Object] until_occurrences Value to be assigned

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 154
def until_occurrences=(until_occurrences)
  if !until_occurrences.nil? && until_occurrences > 2147483647
    fail ArgumentError, 'invalid value for "until_occurrences", must be smaller than or equal to 2147483647.'
  end

  @until_occurrences = until_occurrences
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/datadog_api_client/v1/models/downtime_recurrence.rb, line 136
def valid?
  return false if !@period.nil? && @period > 2147483647
  return false if !@until_occurrences.nil? && @until_occurrences > 2147483647
  true
end