Class: PureCloud::Trunk

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Trunk

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 233

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?(:'description')
    
    
    self.description = attributes[:'description']
    
  
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#connected_status ⇒ Object

The connected status of the trunk



79
80
81
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 79

def connected_status
  @connected_status
end

#created_by ⇒ Object

The ID of the user that created the resource.



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

def created_by
  @created_by
end

#created_by_app ⇒ Object

The application that created the resource.



52
53
54
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 52

def created_by_app
  @created_by_app
end

#date_created ⇒ Object

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



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

def date_created
  @date_created
end

#date_modified ⇒ Object

The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def date_modified
  @date_modified
end

#description ⇒ Object

The resource’s description.



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

def description
  @description
end

#edge ⇒ Object

The Edge using this trunk.



58
59
60
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 58

def edge
  @edge
end

#edge_group ⇒ Object

The edge group associated with this trunk.



67
68
69
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 67

def edge_group
  @edge_group
end

#enabled ⇒ Object

True if the Edge used by this trunk is in-service



73
74
75
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 73

def enabled
  @enabled
end

#family ⇒ Object

The IP Network Family of the trunk



97
98
99
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 97

def family
  @family
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 22

def id
  @id
end

#in_service ⇒ Object

True if this trunk is in-service. This comes from the trunk_enabled property of the referenced trunk base.



70
71
72
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 70

def in_service
  @in_service
end

#ip_status ⇒ Object

The trunk ipStatus



88
89
90
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 88

def ip_status
  @ip_status
end

#logical_interface ⇒ Object

The Logical Interface on the Edge to which the trunk is assigned.



76
77
78
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 76

def logical_interface
  @logical_interface
end

#modified_by ⇒ Object

The ID of the user that last modified the resource.



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

def modified_by
  @modified_by
end

#modified_by_app ⇒ Object

The application that last modified the resource.



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

def modified_by_app
  @modified_by_app
end

#name ⇒ Object

The name of the entity.



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

def name
  @name
end

#options_enabled_status ⇒ Object

Returns Enabled when the trunk base supports the availability interval and it has a value greater than 0.



91
92
93
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 91

def options_enabled_status
  @options_enabled_status
end

#options_status ⇒ Object

The trunk optionsStatus



82
83
84
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 82

def options_status
  @options_status
end

#proxy_address_list ⇒ Object

The list of proxy addresses (ports if provided) for the trunk



100
101
102
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 100

def proxy_address_list
  @proxy_address_list
end

#registers_enabled_status ⇒ Object

Returns Enabled when the trunk base supports the registration interval and it has a value greater than 0.



94
95
96
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 94

def registers_enabled_status
  @registers_enabled_status
end

#registers_status ⇒ Object

The trunk registersStatus



85
86
87
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 85

def registers_status
  @registers_status
end

#self_uri ⇒ Object

The URI for this object



103
104
105
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 103

def self_uri
  @self_uri
end

#state ⇒ Object

Indicates if the resource is active, inactive, or deleted.



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

def state
  @state
end

#trunk_base ⇒ Object

The trunk base configuration used on this trunk.



61
62
63
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 61

def trunk_base
  @trunk_base
end

#trunk_metabase ⇒ Object

The metabase used to create this trunk.



64
65
66
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 64

def trunk_metabase
  @trunk_metabase
end

#trunk_type ⇒ Object

The type of this trunk.



55
56
57
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 55

def trunk_type
  @trunk_type
end

#version ⇒ Object

The current version of the resource.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 31

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 106

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',
    
    :'trunk_type' => :'trunkType',
    
    :'edge' => :'edge',
    
    :'trunk_base' => :'trunkBase',
    
    :'trunk_metabase' => :'trunkMetabase',
    
    :'edge_group' => :'edgeGroup',
    
    :'in_service' => :'inService',
    
    :'enabled' => :'enabled',
    
    :'logical_interface' => :'logicalInterface',
    
    :'connected_status' => :'connectedStatus',
    
    :'options_status' => :'optionsStatus',
    
    :'registers_status' => :'registersStatus',
    
    :'ip_status' => :'ipStatus',
    
    :'options_enabled_status' => :'optionsEnabledStatus',
    
    :'registers_enabled_status' => :'registersEnabledStatus',
    
    :'family' => :'family',
    
    :'proxy_address_list' => :'proxyAddressList',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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',
    
    :'trunk_type' => :'String',
    
    :'edge' => :'DomainEntityRef',
    
    :'trunk_base' => :'DomainEntityRef',
    
    :'trunk_metabase' => :'DomainEntityRef',
    
    :'edge_group' => :'DomainEntityRef',
    
    :'in_service' => :'BOOLEAN',
    
    :'enabled' => :'BOOLEAN',
    
    :'logical_interface' => :'DomainEntityRef',
    
    :'connected_status' => :'TrunkConnectedStatus',
    
    :'options_status' => :'Array<TrunkMetricsOptions>',
    
    :'registers_status' => :'Array<TrunkMetricsRegisters>',
    
    :'ip_status' => :'TrunkMetricsNetworkTypeIp',
    
    :'options_enabled_status' => :'String',
    
    :'registers_enabled_status' => :'String',
    
    :'family' => :'Integer',
    
    :'proxy_address_list' => :'Array<String>',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 831

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 &&
      trunk_type == o.trunk_type &&
      edge == o.edge &&
      trunk_base == o.trunk_base &&
      trunk_metabase == o.trunk_metabase &&
      edge_group == o.edge_group &&
      in_service == o.in_service &&
      enabled == o.enabled &&
      logical_interface == o.logical_interface &&
      connected_status == o.connected_status &&
      options_status == o.options_status &&
      registers_status == o.registers_status &&
      ip_status == o.ip_status &&
      options_enabled_status == o.options_enabled_status &&
      registers_enabled_status == o.registers_enabled_status &&
      family == o.family &&
      proxy_address_list == o.proxy_address_list &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 896

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



956
957
958
959
960
961
962
963
964
965
966
967
968
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 956

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



877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 877

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


866
867
868
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 866

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



872
873
874
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 872

def hash
  [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, trunk_type, edge, trunk_base, trunk_metabase, edge_group, in_service, enabled, logical_interface, connected_status, options_status, registers_status, ip_status, options_enabled_status, registers_enabled_status, family, proxy_address_list, 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



502
503
504
505
506
507
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 502

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



939
940
941
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 939

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



944
945
946
947
948
949
950
951
952
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 944

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 



934
935
936
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 934

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



511
512
513
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
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 511

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

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["active", "inactive", "deleted"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["EXTERNAL", "PHONE", "EDGE"]
  if @trunk_type && !allowed_values.include?(@trunk_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["ENABLED", "DISABLED", "NOT_SUPPORTED"]
  if @options_enabled_status && !allowed_values.include?(@options_enabled_status)
    return false
  end
  
  
  
  
  
  allowed_values = ["ENABLED", "DISABLED", "NOT_SUPPORTED"]
  if @registers_enabled_status && !allowed_values.include?(@registers_enabled_status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end