Class: PureCloud::HeartBeatAlert

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/heart_beat_alert.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HeartBeatAlert

Returns a new instance of HeartBeatAlert.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 106

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'senderId']
    self.sender_id = attributes[:'senderId']
  end
  
  if attributes[:'heartBeatTimeoutInMinutes']
    self.heart_beat_timeout_in_minutes = attributes[:'heartBeatTimeoutInMinutes']
  end
  
  if attributes[:'ruleId']
    self.rule_id = attributes[:'ruleId']
  end
  
  if attributes[:'startDate']
    self.start_date = attributes[:'startDate']
  end
  
  if attributes[:'endDate']
    self.end_date = attributes[:'endDate']
  end
  
  if attributes[:'notificationUsers']
    if (value = attributes[:'notificationUsers']).is_a?(Array)
      self.notification_users = value
    end
  end
  
  if attributes[:'alertTypes']
    if (value = attributes[:'alertTypes']).is_a?(Array)
      self.alert_types = value
    end
  end
  
  if attributes[:'ruleType']
    self.rule_type = attributes[:'ruleType']
  end
  
  if attributes[:'ruleUri']
    self.rule_uri = attributes[:'ruleUri']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#alert_types ⇒ Object

A collection of notification methods.



46
47
48
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 46

def alert_types
  @alert_types
end

#end_date ⇒ Object

The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



40
41
42
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 40

def end_date
  @end_date
end

#heart_beat_timeout_in_minutes ⇒ Object

The number of minutes to wait before alerting missing heartbeats.



31
32
33
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 31

def heart_beat_timeout_in_minutes
  @heart_beat_timeout_in_minutes
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 22

def id
  @id
end

#name ⇒ Object

Name of the rule



25
26
27
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 25

def name
  @name
end

#notification_users ⇒ Object

The ids of users who were notified of alarm state change.



43
44
45
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 43

def notification_users
  @notification_users
end

#rule_id ⇒ Object

The id of the rule.



34
35
36
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 34

def rule_id
  @rule_id
end

#rule_type ⇒ Object

The type of heartbeat rule that generated the alert



49
50
51
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 49

def rule_type
  @rule_type
end

#rule_uri ⇒ Object

Returns the value of attribute rule_uri.



51
52
53
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 51

def rule_uri
  @rule_uri
end

#self_uri ⇒ Object

The URI for this object



54
55
56
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 54

def self_uri
  @self_uri
end

#sender_id ⇒ Object

The value that identifies the sender of the heartbeat.



28
29
30
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 28

def sender_id
  @sender_id
end

#start_date ⇒ Object

The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



37
38
39
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 37

def start_date
  @start_date
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 57

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'sender_id' => :'senderId',
    
    :'heart_beat_timeout_in_minutes' => :'heartBeatTimeoutInMinutes',
    
    :'rule_id' => :'ruleId',
    
    :'start_date' => :'startDate',
    
    :'end_date' => :'endDate',
    
    :'notification_users' => :'notificationUsers',
    
    :'alert_types' => :'alertTypes',
    
    :'rule_type' => :'ruleType',
    
    :'rule_uri' => :'ruleUri',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 88

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'sender_id' => :'String',
    :'heart_beat_timeout_in_minutes' => :'Integer',
    :'rule_id' => :'String',
    :'start_date' => :'DateTime',
    :'end_date' => :'DateTime',
    :'notification_users' => :'Array<User>',
    :'alert_types' => :'Array<String>',
    :'rule_type' => :'String',
    :'rule_uri' => :'String',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      sender_id == o.sender_id &&
      heart_beat_timeout_in_minutes == o.heart_beat_timeout_in_minutes &&
      rule_id == o.rule_id &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      notification_users == o.notification_users &&
      alert_types == o.alert_types &&
      rule_type == o.rule_type &&
      rule_uri == o.rule_uri &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 224

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), 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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

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



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 284

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

build the object from hash



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 205

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


195
196
197
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 195

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



200
201
202
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 200

def hash
  [id, name, sender_id, heart_beat_timeout_in_minutes, rule_id, start_date, end_date, notification_users, alert_types, rule_type, rule_uri, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



267
268
269
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 267

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



272
273
274
275
276
277
278
279
280
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 272

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ Object 



262
263
264
 
# File 'lib/purecloud/models/heart_beat_alert.rb', line 262

def to_s
  to_hash.to_s
end