Class: PureCloud::HeartBeatRule

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/heart_beat_rule.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HeartBeatRule

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 85

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

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

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'senderId')
    self.sender_id = attributes[:'senderId']
  end

  if attributes.has_key?(:'heartBeatTimeoutInMinutes')
    self.heart_beat_timeout_in_minutes = attributes[:'heartBeatTimeoutInMinutes']
  end

  if attributes.has_key?(:'enabled')
    self.enabled = attributes[:'enabled']
  end

  if attributes.has_key?(:'inAlarm')
    self.in_alarm = attributes[:'inAlarm']
  end

  if attributes.has_key?(:'notificationUsers')
    if (value = attributes[:'notificationUsers']).is_a?(Array)
      self.notification_users = value
    end
  end

  if attributes.has_key?(:'alertTypes')
    if (value = attributes[:'alertTypes']).is_a?(Array)
      self.alert_types = value
    end
  end

  if attributes.has_key?(:'ruleType')
    self.rule_type = attributes[:'ruleType']
  end

  if attributes.has_key?(:'selfUri')
    self.self_uri = attributes[:'selfUri']
  end

end

Instance Attribute Details

#alert_types ⇒ Object

A collection of notification methods.



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 43

def alert_types
  @alert_types
end

#enabled ⇒ Object

Indicates if the rule is enabled.



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 34

def enabled
  @enabled
end

#heart_beat_timeout_in_minutes ⇒ Object

The number of minutes to wait before alerting missing heartbeats.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.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/purecloudplatformclientv2/models/heart_beat_rule.rb', line 22

def id
  @id
end

#in_alarm ⇒ Object

Indicates if the rule is in alarm state.



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 37

def in_alarm
  @in_alarm
end

#name ⇒ Object

Name of the rule



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 25

def name
  @name
end

#notification_users ⇒ Object

The ids of users who will be notified of alarm state change.



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 40

def notification_users
  @notification_users
end

#rule_type ⇒ Object

The type of system the will be generating the heartbeat.



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 46

def rule_type
  @rule_type
end

#self_uri ⇒ Object

The URI for this object



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 49

def self_uri
  @self_uri
end

#sender_id ⇒ Object

The value that identifies the sender of the heartbeat.



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 28

def sender_id
  @sender_id
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 52

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'sender_id' => :'senderId',
    :'heart_beat_timeout_in_minutes' => :'heartBeatTimeoutInMinutes',
    :'enabled' => :'enabled',
    :'in_alarm' => :'inAlarm',
    :'notification_users' => :'notificationUsers',
    :'alert_types' => :'alertTypes',
    :'rule_type' => :'ruleType',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 68

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'sender_id' => :'String',
    :'heart_beat_timeout_in_minutes' => :'Integer',
    :'enabled' => :'BOOLEAN',
    :'in_alarm' => :'BOOLEAN',
    :'notification_users' => :'Array<User>',
    :'alert_types' => :'Array<String>',
    :'rule_type' => :'String',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 193

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 &&
      enabled == o.enabled &&
      in_alarm == o.in_alarm &&
      notification_users == o.notification_users &&
      alert_types == o.alert_types &&
      rule_type == o.rule_type &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
269
270
271
272
273
274
275
276
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 240

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



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 300

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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 221

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


210
211
212
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 210

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



216
217
218
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 216

def hash
  [id, name, sender_id, heart_beat_timeout_in_minutes, enabled, in_alarm, notification_users, alert_types, rule_type, self_uri].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



139
140
141
142
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 139

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



283
284
285
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 283

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



288
289
290
291
292
293
294
295
296
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 288

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 



278
279
280
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 278

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_rule.rb', line 146

def valid?
  if @name.nil?
    return false
  end

  if @sender_id.nil?
    return false
  end

  if @heart_beat_timeout_in_minutes.nil?
    return false
  end

  if @enabled.nil?
    return false
  end

  if @notification_users.nil?
    return false
  end

  if @alert_types.nil?
    return false
  end

  if @rule_type.nil?
    return false
  end

  allowed_values = ["EDGE"]
  if @rule_type && !allowed_values.include?(@rule_type)
    return false
  end
end