Class: PureCloud::Edge

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Edge

Returns a new instance of Edge.



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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
# File 'lib/purecloud/models/edge.rb', line 232

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[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'version']
    self.version = attributes[:'version']
  end
  
  if attributes[:'dateCreated']
    self.date_created = attributes[:'dateCreated']
  end
  
  if attributes[:'dateModified']
    self.date_modified = attributes[:'dateModified']
  end
  
  if attributes[:'modifiedBy']
    self.modified_by = attributes[:'modifiedBy']
  end
  
  if attributes[:'createdBy']
    self.created_by = attributes[:'createdBy']
  end
  
  if attributes[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'modifiedByApp']
    self.modified_by_app = attributes[:'modifiedByApp']
  end
  
  if attributes[:'createdByApp']
    self.created_by_app = attributes[:'createdByApp']
  end
  
  if attributes[:'interfaces']
    if (value = attributes[:'interfaces']).is_a?(Array)
      self.interfaces = value
    end
  end
  
  if attributes[:'make']
    self.make = attributes[:'make']
  end
  
  if attributes[:'model']
    self.model = attributes[:'model']
  end
  
  if attributes[:'apiVersion']
    self.api_version = attributes[:'apiVersion']
  end
  
  if attributes[:'softwareVersion']
    self.software_version = attributes[:'softwareVersion']
  end
  
  if attributes[:'softwareVersionTimestamp']
    self.software_version_timestamp = attributes[:'softwareVersionTimestamp']
  end
  
  if attributes[:'softwareVersionPlatform']
    self.software_version_platform = attributes[:'softwareVersionPlatform']
  end
  
  if attributes[:'softwareVersionConfiguration']
    self.software_version_configuration = attributes[:'softwareVersionConfiguration']
  end
  
  if attributes[:'fullSoftwareVersion']
    self.full_software_version = attributes[:'fullSoftwareVersion']
  end
  
  if attributes[:'pairingId']
    self.pairing_id = attributes[:'pairingId']
  end
  
  if attributes[:'fingerprint']
    self.fingerprint = attributes[:'fingerprint']
  end
  
  if attributes[:'fingerprintHint']
    self.fingerprint_hint = attributes[:'fingerprintHint']
  end
  
  if attributes[:'currentVersion']
    self.current_version = attributes[:'currentVersion']
  end
  
  if attributes[:'stagedVersion']
    self.staged_version = attributes[:'stagedVersion']
  end
  
  if attributes[:'patch']
    self.patch = attributes[:'patch']
  end
  
  if attributes[:'statusCode']
    self.status_code = attributes[:'statusCode']
  end
  
  if attributes[:'edgeGroup']
    self.edge_group = attributes[:'edgeGroup']
  end
  
  if attributes[:'site']
    self.site = attributes[:'site']
  end
  
  if attributes[:'softwareStatus']
    self.software_status = attributes[:'softwareStatus']
  end
  
  if attributes[:'onlineStatus']
    self.online_status = attributes[:'onlineStatus']
  end
  
  if attributes[:'serialNumber']
    self.serial_number = attributes[:'serialNumber']
  end
  
  if attributes[:'physicalEdge']
    self.physical_edge = attributes[:'physicalEdge']
  end
  
  if attributes[:'managed']
    self.managed = attributes[:'managed']
  end
  
  if attributes[:'edgeDeploymentType']
    self.edge_deployment_type = attributes[:'edgeDeploymentType']
  end
  
  if attributes[:'callDrainingState']
    self.call_draining_state = attributes[:'callDrainingState']
  end
  
  if attributes[:'conversationCount']
    self.conversation_count = attributes[:'conversationCount']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#api_versionObject

Returns the value of attribute api_version.



53
54
55
# File 'lib/purecloud/models/edge.rb', line 53

def api_version
  @api_version
end

#call_draining_stateObject

Returns the value of attribute call_draining_state.



97
98
99
# File 'lib/purecloud/models/edge.rb', line 97

def call_draining_state
  @call_draining_state
end

#conversation_countObject

Returns the value of attribute conversation_count.



99
100
101
# File 'lib/purecloud/models/edge.rb', line 99

def conversation_count
  @conversation_count
end

#created_byObject

Returns the value of attribute created_by.



39
40
41
# File 'lib/purecloud/models/edge.rb', line 39

def created_by
  @created_by
end

#created_by_appObject

Returns the value of attribute created_by_app.



45
46
47
# File 'lib/purecloud/models/edge.rb', line 45

def created_by_app
  @created_by_app
end

#current_versionObject

Returns the value of attribute current_version.



72
73
74
# File 'lib/purecloud/models/edge.rb', line 72

def current_version
  @current_version
end

#date_createdObject

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



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

def date_created
  @date_created
end

#date_modifiedObject

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



35
36
37
# File 'lib/purecloud/models/edge.rb', line 35

def date_modified
  @date_modified
end

#descriptionObject

Returns the value of attribute description.



27
28
29
# File 'lib/purecloud/models/edge.rb', line 27

def description
  @description
end

#edge_deployment_typeObject

Returns the value of attribute edge_deployment_type.



95
96
97
# File 'lib/purecloud/models/edge.rb', line 95

def edge_deployment_type
  @edge_deployment_type
end

#edge_groupObject

Returns the value of attribute edge_group.



80
81
82
# File 'lib/purecloud/models/edge.rb', line 80

def edge_group
  @edge_group
end

#fingerprintObject

Returns the value of attribute fingerprint.



68
69
70
# File 'lib/purecloud/models/edge.rb', line 68

def fingerprint
  @fingerprint
end

#fingerprint_hintObject

Returns the value of attribute fingerprint_hint.



70
71
72
# File 'lib/purecloud/models/edge.rb', line 70

def fingerprint_hint
  @fingerprint_hint
end

#full_software_versionObject

Returns the value of attribute full_software_version.



63
64
65
# File 'lib/purecloud/models/edge.rb', line 63

def full_software_version
  @full_software_version
end

#idObject

The globally unique identifier for the object.



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

def id
  @id
end

#interfacesObject

Returns the value of attribute interfaces.



47
48
49
# File 'lib/purecloud/models/edge.rb', line 47

def interfaces
  @interfaces
end

#makeObject

Returns the value of attribute make.



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

def make
  @make
end

#managedObject

Returns the value of attribute managed.



93
94
95
# File 'lib/purecloud/models/edge.rb', line 93

def managed
  @managed
end

#modelObject

Returns the value of attribute model.



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

def model
  @model
end

#modified_byObject

Returns the value of attribute modified_by.



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

def modified_by
  @modified_by
end

#modified_by_appObject

Returns the value of attribute modified_by_app.



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

def modified_by_app
  @modified_by_app
end

#nameObject

The name of the entity.



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

def name
  @name
end

#online_statusObject

Returns the value of attribute online_status.



87
88
89
# File 'lib/purecloud/models/edge.rb', line 87

def online_status
  @online_status
end

#pairing_idObject

The pairing Id for a hardware Edge in the format: 00000-00000-00000-00000-00000. This field is only required when creating an Edge with a deployment type of HARDWARE.



66
67
68
# File 'lib/purecloud/models/edge.rb', line 66

def pairing_id
  @pairing_id
end

#patchObject

Returns the value of attribute patch.



76
77
78
# File 'lib/purecloud/models/edge.rb', line 76

def patch
  @patch
end

#physical_edgeObject

Returns the value of attribute physical_edge.



91
92
93
# File 'lib/purecloud/models/edge.rb', line 91

def physical_edge
  @physical_edge
end

#self_uriObject

The URI for this object



102
103
104
# File 'lib/purecloud/models/edge.rb', line 102

def self_uri
  @self_uri
end

#serial_numberObject

Returns the value of attribute serial_number.



89
90
91
# File 'lib/purecloud/models/edge.rb', line 89

def serial_number
  @serial_number
end

#siteObject

The Site to which the Edge is assigned.



83
84
85
# File 'lib/purecloud/models/edge.rb', line 83

def site
  @site
end

#software_statusObject

Returns the value of attribute software_status.



85
86
87
# File 'lib/purecloud/models/edge.rb', line 85

def software_status
  @software_status
end

#software_versionObject

Returns the value of attribute software_version.



55
56
57
# File 'lib/purecloud/models/edge.rb', line 55

def software_version
  @software_version
end

#software_version_configurationObject

Returns the value of attribute software_version_configuration.



61
62
63
# File 'lib/purecloud/models/edge.rb', line 61

def software_version_configuration
  @software_version_configuration
end

#software_version_platformObject

Returns the value of attribute software_version_platform.



59
60
61
# File 'lib/purecloud/models/edge.rb', line 59

def software_version_platform
  @software_version_platform
end

#software_version_timestampObject

Returns the value of attribute software_version_timestamp.



57
58
59
# File 'lib/purecloud/models/edge.rb', line 57

def software_version_timestamp
  @software_version_timestamp
end

#staged_versionObject

Returns the value of attribute staged_version.



74
75
76
# File 'lib/purecloud/models/edge.rb', line 74

def staged_version
  @staged_version
end

#stateObject

Returns the value of attribute state.



41
42
43
# File 'lib/purecloud/models/edge.rb', line 41

def state
  @state
end

#status_codeObject

Returns the value of attribute status_code.



78
79
80
# File 'lib/purecloud/models/edge.rb', line 78

def status_code
  @status_code
end

#versionObject

Returns the value of attribute version.



29
30
31
# File 'lib/purecloud/models/edge.rb', line 29

def version
  @version
end

Class Method Details

.attribute_mapObject

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



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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# File 'lib/purecloud/models/edge.rb', line 105

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'version' => :'version',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'modified_by' => :'modifiedBy',
    
    :'created_by' => :'createdBy',
    
    :'state' => :'state',
    
    :'modified_by_app' => :'modifiedByApp',
    
    :'created_by_app' => :'createdByApp',
    
    :'interfaces' => :'interfaces',
    
    :'make' => :'make',
    
    :'model' => :'model',
    
    :'api_version' => :'apiVersion',
    
    :'software_version' => :'softwareVersion',
    
    :'software_version_timestamp' => :'softwareVersionTimestamp',
    
    :'software_version_platform' => :'softwareVersionPlatform',
    
    :'software_version_configuration' => :'softwareVersionConfiguration',
    
    :'full_software_version' => :'fullSoftwareVersion',
    
    :'pairing_id' => :'pairingId',
    
    :'fingerprint' => :'fingerprint',
    
    :'fingerprint_hint' => :'fingerprintHint',
    
    :'current_version' => :'currentVersion',
    
    :'staged_version' => :'stagedVersion',
    
    :'patch' => :'patch',
    
    :'status_code' => :'statusCode',
    
    :'edge_group' => :'edgeGroup',
    
    :'site' => :'site',
    
    :'software_status' => :'softwareStatus',
    
    :'online_status' => :'onlineStatus',
    
    :'serial_number' => :'serialNumber',
    
    :'physical_edge' => :'physicalEdge',
    
    :'managed' => :'managed',
    
    :'edge_deployment_type' => :'edgeDeploymentType',
    
    :'call_draining_state' => :'callDrainingState',
    
    :'conversation_count' => :'conversationCount',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_typesObject

Attribute type mapping.



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'lib/purecloud/models/edge.rb', line 188

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'version' => :'Integer',
    :'date_created' => :'DateTime',
    :'date_modified' => :'DateTime',
    :'modified_by' => :'String',
    :'created_by' => :'String',
    :'state' => :'String',
    :'modified_by_app' => :'String',
    :'created_by_app' => :'String',
    :'interfaces' => :'Array<EdgeInterface>',
    :'make' => :'String',
    :'model' => :'String',
    :'api_version' => :'String',
    :'software_version' => :'String',
    :'software_version_timestamp' => :'String',
    :'software_version_platform' => :'String',
    :'software_version_configuration' => :'String',
    :'full_software_version' => :'String',
    :'pairing_id' => :'String',
    :'fingerprint' => :'String',
    :'fingerprint_hint' => :'String',
    :'current_version' => :'String',
    :'staged_version' => :'String',
    :'patch' => :'String',
    :'status_code' => :'String',
    :'edge_group' => :'EdgeGroup',
    :'site' => :'Site',
    :'software_status' => :'DomainEdgeSoftwareUpdateDto',
    :'online_status' => :'String',
    :'serial_number' => :'String',
    :'physical_edge' => :'BOOLEAN',
    :'managed' => :'BOOLEAN',
    :'edge_deployment_type' => :'String',
    :'call_draining_state' => :'String',
    :'conversation_count' => :'Integer',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
# File 'lib/purecloud/models/edge.rb', line 441

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      version == o.version &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      modified_by == o.modified_by &&
      created_by == o.created_by &&
      state == o.state &&
      modified_by_app == o.modified_by_app &&
      created_by_app == o.created_by_app &&
      interfaces == o.interfaces &&
      make == o.make &&
      model == o.model &&
      api_version == o.api_version &&
      software_version == o.software_version &&
      software_version_timestamp == o.software_version_timestamp &&
      software_version_platform == o.software_version_platform &&
      software_version_configuration == o.software_version_configuration &&
      full_software_version == o.full_software_version &&
      pairing_id == o.pairing_id &&
      fingerprint == o.fingerprint &&
      fingerprint_hint == o.fingerprint_hint &&
      current_version == o.current_version &&
      staged_version == o.staged_version &&
      patch == o.patch &&
      status_code == o.status_code &&
      edge_group == o.edge_group &&
      site == o.site &&
      software_status == o.software_status &&
      online_status == o.online_status &&
      serial_number == o.serial_number &&
      physical_edge == o.physical_edge &&
      managed == o.managed &&
      edge_deployment_type == o.edge_deployment_type &&
      call_draining_state == o.call_draining_state &&
      conversation_count == o.conversation_count &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
# File 'lib/purecloud/models/edge.rb', line 514

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



574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'lib/purecloud/models/edge.rb', line 574

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



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
# File 'lib/purecloud/models/edge.rb', line 495

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


485
486
487
# File 'lib/purecloud/models/edge.rb', line 485

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



490
491
492
# File 'lib/purecloud/models/edge.rb', line 490

def hash
  [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, interfaces, make, model, api_version, software_version, software_version_timestamp, software_version_platform, software_version_configuration, full_software_version, pairing_id, fingerprint, fingerprint_hint, current_version, staged_version, patch, status_code, edge_group, site, software_status, online_status, serial_number, physical_edge, managed, edge_deployment_type, call_draining_state, conversation_count, self_uri].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



557
558
559
# File 'lib/purecloud/models/edge.rb', line 557

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



562
563
564
565
566
567
568
569
570
# File 'lib/purecloud/models/edge.rb', line 562

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_sObject



552
553
554
# File 'lib/purecloud/models/edge.rb', line 552

def to_s
  to_hash.to_s
end