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

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseGenericModel

included

Instance Attribute Details

#_unparsed ⇒ Object

whether the object has unparsed attributes



23
24
25
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 23

def _unparsed
  @_unparsed
end

#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 are supported.

Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION). More examples available in this downtime guide



29
30
31
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 29

def rrule
  @rrule
end

#type ⇒ Object

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



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

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.



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

def until_date
  @until_date
end

#until_occurrences ⇒ Object

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



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

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.



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

def week_days
  @week_days
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



56
57
58
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 56

def self.acceptable_attributes
  attribute_map.values
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



194
195
196
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 194

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

Instance Method Details

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 224

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)
    res = klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
    if res.instance_of? DatadogAPIClient::V1::UnparsedObject
      self._unparsed = true
    end
    res
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 302

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 201

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


181
182
183
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 181

def eql?(o)
  self == o
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 125

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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



278
279
280
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 278

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



272
273
274
 
# File 'lib/datadog_api_client/v1/models/downtime_recurrence.rb', line 272

def to_s
  to_hash.to_s
end