Class: PureCloud::Alert

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Alert

Returns a new instance of Alert.



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
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
166
167
168
169
 
# File 'lib/purecloud/models/alert.rb', line 98

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[:'title']
    self.title = attributes[:'title']
  end
  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'unread']
    self.unread = attributes[:'unread']
  else
    self.unread = false
  end
  
  if attributes[:'entity']
    self.entity = attributes[:'entity']
  end
  
  if attributes[:'metric']
    self.metric = attributes[:'metric']
  end
  
  if attributes[:'metricThresholds']
    if (value = attributes[:'metricThresholds']).is_a?(Array)
      self.metric_thresholds = value
    end
  end
  
  if attributes[:'metricValue']
    self.metric_value = attributes[:'metricValue']
  end
  
  if attributes[:'startTime']
    self.start_time = attributes[:'startTime']
  end
  
  if attributes[:'endTime']
    self.end_time = attributes[:'endTime']
  end
  
  if attributes[:'mediaType']
    self.media_type = attributes[:'mediaType']
  end
  
  if attributes[:'statistic']
    self.statistic = attributes[:'statistic']
  end
  
  if attributes[:'ruleUri']
    self.rule_uri = attributes[:'ruleUri']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.



12
13
14
 
# File 'lib/purecloud/models/alert.rb', line 12

def description
  @description
end

#end_time ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def end_time
  @end_time
end

#entity ⇒ Object

Returns the value of attribute entity.



16
17
18
 
# File 'lib/purecloud/models/alert.rb', line 16

def entity
  @entity
end

#id ⇒ Object

The globally unique identifier for the object.



6
7
8
 
# File 'lib/purecloud/models/alert.rb', line 6

def id
  @id
end

#media_type ⇒ Object

Returns the value of attribute media_type.



30
31
32
 
# File 'lib/purecloud/models/alert.rb', line 30

def media_type
  @media_type
end

#metric ⇒ Object

Returns the value of attribute metric.



18
19
20
 
# File 'lib/purecloud/models/alert.rb', line 18

def metric
  @metric
end

#metric_thresholds ⇒ Object

Returns the value of attribute metric_thresholds.



20
21
22
 
# File 'lib/purecloud/models/alert.rb', line 20

def metric_thresholds
  @metric_thresholds
end

#metric_value ⇒ Object

Returns the value of attribute metric_value.



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

def metric_value
  @metric_value
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/purecloud/models/alert.rb', line 8

def name
  @name
end

#rule_uri ⇒ Object

Returns the value of attribute rule_uri.



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

def rule_uri
  @rule_uri
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#start_time ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def start_time
  @start_time
end

#statistic ⇒ Object

Returns the value of attribute statistic.



32
33
34
 
# File 'lib/purecloud/models/alert.rb', line 32

def statistic
  @statistic
end

#title ⇒ Object

Returns the value of attribute title.



10
11
12
 
# File 'lib/purecloud/models/alert.rb', line 10

def title
  @title
end

#unread ⇒ Object

Returns the value of attribute unread.



14
15
16
 
# File 'lib/purecloud/models/alert.rb', line 14

def unread
  @unread
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/purecloud/models/alert.rb', line 40

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'title' => :'title',
    
    :'description' => :'description',
    
    :'unread' => :'unread',
    
    :'entity' => :'entity',
    
    :'metric' => :'metric',
    
    :'metric_thresholds' => :'metricThresholds',
    
    :'metric_value' => :'metricValue',
    
    :'start_time' => :'startTime',
    
    :'end_time' => :'endTime',
    
    :'media_type' => :'mediaType',
    
    :'statistic' => :'statistic',
    
    :'rule_uri' => :'ruleUri',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/purecloud/models/alert.rb', line 77

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'title' => :'String',
    :'description' => :'String',
    :'unread' => :'BOOLEAN',
    :'entity' => :'Entity',
    :'metric' => :'String',
    :'metric_thresholds' => :'Array<MetricThreshold>',
    :'metric_value' => :'Float',
    :'start_time' => :'DateTime',
    :'end_time' => :'DateTime',
    :'media_type' => :'String',
    :'statistic' => :'String',
    :'rule_uri' => :'String',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/purecloud/models/alert.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      title == o.title &&
      description == o.description &&
      unread == o.unread &&
      entity == o.entity &&
      metric == o.metric &&
      metric_thresholds == o.metric_thresholds &&
      metric_value == o.metric_value &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      media_type == o.media_type &&
      statistic == o.statistic &&
      rule_uri == o.rule_uri &&
      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
 
# File 'lib/purecloud/models/alert.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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/purecloud/models/alert.rb', line 297

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/purecloud/models/alert.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

Returns:

  • (Boolean)

See Also:

  • `==` method


211
212
213
 
# File 'lib/purecloud/models/alert.rb', line 211

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



216
217
218
 
# File 'lib/purecloud/models/alert.rb', line 216

def hash
  [id, name, title, description, unread, entity, metric, metric_thresholds, metric_value, start_time, end_time, media_type, statistic, rule_uri, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



280
281
282
 
# File 'lib/purecloud/models/alert.rb', line 280

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



285
286
287
288
289
290
291
292
293
 
# File 'lib/purecloud/models/alert.rb', line 285

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 



275
276
277
 
# File 'lib/purecloud/models/alert.rb', line 275

def to_s
  to_hash.to_s
end