Class: PureCloud::DomainLogicalInterface

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DomainLogicalInterface

Returns a new instance of DomainLogicalInterface.



218
219
220
221
222
223
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
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
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 218

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[:'edgeUri']
    self.edge_uri = attributes[:'edgeUri']
  end
  
  if attributes[:'edgeAssignedId']
    self.edge_assigned_id = attributes[:'edgeAssignedId']
  end
  
  if attributes[:'friendlyName']
    self.friendly_name = attributes[:'friendlyName']
  end
  
  if attributes[:'vlanTagId']
    self.vlan_tag_id = attributes[:'vlanTagId']
  end
  
  if attributes[:'hardwareAddress']
    self.hardware_address = attributes[:'hardwareAddress']
  end
  
  if attributes[:'physicalAdapterId']
    self.physical_adapter_id = attributes[:'physicalAdapterId']
  end
  
  if attributes[:'ifStatus']
    self.if_status = attributes[:'ifStatus']
  end
  
  if attributes[:'interfaceType']
    self.interface_type = attributes[:'interfaceType']
  end
  
  if attributes[:'routes']
    if (value = attributes[:'routes']).is_a?(Array)
      self.routes = value
    end
  end
  
  if attributes[:'addresses']
    if (value = attributes[:'addresses']).is_a?(Array)
      self.addresses = value
    end
  end
  
  if attributes[:'ipv4Capabilities']
    self.ipv4_capabilities = attributes[:'ipv4Capabilities']
  end
  
  if attributes[:'ipv6Capabilities']
    self.ipv6_capabilities = attributes[:'ipv6Capabilities']
  end
  
  if attributes[:'currentState']
    self.current_state = attributes[:'currentState']
  end
  
  if attributes[:'lastModifiedUserId']
    self.last_modified_user_id = attributes[:'lastModifiedUserId']
  end
  
  if attributes[:'lastModifiedCorrelationId']
    self.last_modified_correlation_id = attributes[:'lastModifiedCorrelationId']
  end
  
  if attributes[:'commandResponses']
    if (value = attributes[:'commandResponses']).is_a?(Array)
      self.command_responses = value
    end
  end
  
  if attributes[:'inheritPhoneTrunkBasesIPv4']
    self.inherit_phone_trunk_bases_i_pv4 = attributes[:'inheritPhoneTrunkBasesIPv4']
  end
  
  if attributes[:'inheritPhoneTrunkBasesIPv6']
    self.inherit_phone_trunk_bases_i_pv6 = attributes[:'inheritPhoneTrunkBasesIPv6']
  end
  
  if attributes[:'useForInternalEdgeCommunication']
    self.use_for_internal_edge_communication = attributes[:'useForInternalEdgeCommunication']
  end
  
  if attributes[:'externalTrunkBaseAssignments']
    if (value = attributes[:'externalTrunkBaseAssignments']).is_a?(Array)
      self.external_trunk_base_assignments = value
    end
  end
  
  if attributes[:'phoneTrunkBaseAssignments']
    if (value = attributes[:'phoneTrunkBaseAssignments']).is_a?(Array)
      self.phone_trunk_base_assignments = value
    end
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#addresses ⇒ Object

The list of IP addresses on this interface. Priority of dns addresses are based on order in the list.



71
72
73
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 71

def addresses
  @addresses
end

#command_responses ⇒ Object

Returns the value of attribute command_responses.



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

def command_responses
  @command_responses
end

#created_by ⇒ Object

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#created_by_app ⇒ Object

Returns the value of attribute created_by_app.



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

def created_by_app
  @created_by_app
end

#current_state ⇒ Object

Returns the value of attribute current_state.



79
80
81
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 79

def current_state
  @current_state
end

#date_created ⇒ Object

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



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

def date_created
  @date_created
end

#date_modified ⇒ Object

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



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

def date_modified
  @date_modified
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#edge_assigned_id ⇒ Object

Returns the value of attribute edge_assigned_id.



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

def edge_assigned_id
  @edge_assigned_id
end

#edge_uri ⇒ Object

Returns the value of attribute edge_uri.



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

def edge_uri
  @edge_uri
end

#external_trunk_base_assignments ⇒ Object

External trunk base settings to use for external communication from this interface.



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

def external_trunk_base_assignments
  @external_trunk_base_assignments
end

#friendly_name ⇒ Object

Friendly Name



52
53
54
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 52

def friendly_name
  @friendly_name
end

#hardware_address ⇒ Object

Hardware Address



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

def hardware_address
  @hardware_address
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#if_status ⇒ Object

Returns the value of attribute if_status.



62
63
64
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 62

def if_status
  @if_status
end

#inherit_phone_trunk_bases_i_pv4 ⇒ Object

The IPv4 phone trunk base assignment will be inherited from the Edge Group.



88
89
90
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 88

def inherit_phone_trunk_bases_i_pv4
  @inherit_phone_trunk_bases_i_pv4
end

#inherit_phone_trunk_bases_i_pv6 ⇒ Object

The IPv6 phone trunk base assignment will be inherited from the Edge Group.



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

def inherit_phone_trunk_bases_i_pv6
  @inherit_phone_trunk_bases_i_pv6
end

#interface_type ⇒ Object

The type of this network interface.



65
66
67
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 65

def interface_type
  @interface_type
end

#ipv4_capabilities ⇒ Object

IPv4 interface settings.



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

def ipv4_capabilities
  @ipv4_capabilities
end

#ipv6_capabilities ⇒ Object

IPv6 interface settings.



77
78
79
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 77

def ipv6_capabilities
  @ipv6_capabilities
end

#last_modified_correlation_id ⇒ Object

Returns the value of attribute last_modified_correlation_id.



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

def last_modified_correlation_id
  @last_modified_correlation_id
end

#last_modified_user_id ⇒ Object

Returns the value of attribute last_modified_user_id.



81
82
83
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 81

def last_modified_user_id
  @last_modified_user_id
end

#modified_by ⇒ Object

Returns the value of attribute modified_by.



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

def modified_by
  @modified_by
end

#modified_by_app ⇒ Object

Returns the value of attribute modified_by_app.



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

def modified_by_app
  @modified_by_app
end

#name ⇒ Object

The name of the entity.



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

def name
  @name
end

#phone_trunk_base_assignments ⇒ Object

Phone trunk base settings to use for phone communication from this interface. These settings will be ignored when "inheritPhoneTrunkBases" is true.



100
101
102
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 100

def phone_trunk_base_assignments
  @phone_trunk_base_assignments
end

#physical_adapter_id ⇒ Object

Physical Adapter Id



60
61
62
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 60

def physical_adapter_id
  @physical_adapter_id
end

#routes ⇒ Object

The list of routes assigned to this interface.



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

def routes
  @routes
end

#self_uri ⇒ Object

The URI for this object



103
104
105
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 103

def self_uri
  @self_uri
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#use_for_internal_edge_communication ⇒ Object

This interface will be used for all internal edge-to-edge communication using settings from the edgeTrunkBaseAssignment on the Edge Group.



94
95
96
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 94

def use_for_internal_edge_communication
  @use_for_internal_edge_communication
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

#vlan_tag_id ⇒ Object

Returns the value of attribute vlan_tag_id.



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

def vlan_tag_id
  @vlan_tag_id
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
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/purecloud/models/domain_logical_interface.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',
    
    :'edge_uri' => :'edgeUri',
    
    :'edge_assigned_id' => :'edgeAssignedId',
    
    :'friendly_name' => :'friendlyName',
    
    :'vlan_tag_id' => :'vlanTagId',
    
    :'hardware_address' => :'hardwareAddress',
    
    :'physical_adapter_id' => :'physicalAdapterId',
    
    :'if_status' => :'ifStatus',
    
    :'interface_type' => :'interfaceType',
    
    :'routes' => :'routes',
    
    :'addresses' => :'addresses',
    
    :'ipv4_capabilities' => :'ipv4Capabilities',
    
    :'ipv6_capabilities' => :'ipv6Capabilities',
    
    :'current_state' => :'currentState',
    
    :'last_modified_user_id' => :'lastModifiedUserId',
    
    :'last_modified_correlation_id' => :'lastModifiedCorrelationId',
    
    :'command_responses' => :'commandResponses',
    
    :'inherit_phone_trunk_bases_i_pv4' => :'inheritPhoneTrunkBasesIPv4',
    
    :'inherit_phone_trunk_bases_i_pv6' => :'inheritPhoneTrunkBasesIPv6',
    
    :'use_for_internal_edge_communication' => :'useForInternalEdgeCommunication',
    
    :'external_trunk_base_assignments' => :'externalTrunkBaseAssignments',
    
    :'phone_trunk_base_assignments' => :'phoneTrunkBaseAssignments',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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',
    :'edge_uri' => :'String',
    :'edge_assigned_id' => :'String',
    :'friendly_name' => :'String',
    :'vlan_tag_id' => :'Integer',
    :'hardware_address' => :'String',
    :'physical_adapter_id' => :'String',
    :'if_status' => :'String',
    :'interface_type' => :'String',
    :'routes' => :'Array<DomainNetworkRoute>',
    :'addresses' => :'Array<DomainNetworkAddress>',
    :'ipv4_capabilities' => :'DomainCapabilities',
    :'ipv6_capabilities' => :'DomainCapabilities',
    :'current_state' => :'String',
    :'last_modified_user_id' => :'String',
    :'last_modified_correlation_id' => :'String',
    :'command_responses' => :'Array<DomainNetworkCommandResponse>',
    :'inherit_phone_trunk_bases_i_pv4' => :'BOOLEAN',
    :'inherit_phone_trunk_bases_i_pv6' => :'BOOLEAN',
    :'use_for_internal_edge_communication' => :'BOOLEAN',
    :'external_trunk_base_assignments' => :'Array<TrunkBaseAssignment>',
    :'phone_trunk_base_assignments' => :'Array<TrunkBaseAssignment>',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



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

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 &&
      edge_uri == o.edge_uri &&
      edge_assigned_id == o.edge_assigned_id &&
      friendly_name == o.friendly_name &&
      vlan_tag_id == o.vlan_tag_id &&
      hardware_address == o.hardware_address &&
      physical_adapter_id == o.physical_adapter_id &&
      if_status == o.if_status &&
      interface_type == o.interface_type &&
      routes == o.routes &&
      addresses == o.addresses &&
      ipv4_capabilities == o.ipv4_capabilities &&
      ipv6_capabilities == o.ipv6_capabilities &&
      current_state == o.current_state &&
      last_modified_user_id == o.last_modified_user_id &&
      last_modified_correlation_id == o.last_modified_correlation_id &&
      command_responses == o.command_responses &&
      inherit_phone_trunk_bases_i_pv4 == o.inherit_phone_trunk_bases_i_pv4 &&
      inherit_phone_trunk_bases_i_pv6 == o.inherit_phone_trunk_bases_i_pv6 &&
      use_for_internal_edge_communication == o.use_for_internal_edge_communication &&
      external_trunk_base_assignments == o.external_trunk_base_assignments &&
      phone_trunk_base_assignments == o.phone_trunk_base_assignments &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
499
500
501
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 465

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



525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 525

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



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 446

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


436
437
438
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 436

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



441
442
443
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 441

def hash
  [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, edge_uri, edge_assigned_id, friendly_name, vlan_tag_id, hardware_address, physical_adapter_id, if_status, interface_type, routes, addresses, ipv4_capabilities, ipv6_capabilities, current_state, last_modified_user_id, last_modified_correlation_id, command_responses, inherit_phone_trunk_bases_i_pv4, inherit_phone_trunk_bases_i_pv6, use_for_internal_edge_communication, external_trunk_base_assignments, phone_trunk_base_assignments, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



508
509
510
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 508

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



513
514
515
516
517
518
519
520
521
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 513

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 



503
504
505
 
# File 'lib/purecloud/models/domain_logical_interface.rb', line 503

def to_s
  to_hash.to_s
end