Class: IntersightClient::PortGroup

Inherits:
InventoryBase show all
Defined in:
lib/intersight_client/models/port_group.rb

Overview

Holder for multiple ports. A switch card will have one or more port groups.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from InventoryBase

#device_mo_id, #dn, #rn

Attributes inherited from MoBaseMo

#account_moid, #ancestors, #create_time, #display_names, #domain_group_moid, #mod_time, #moid, #owners, #parent, #permission_resources, #shared_scope, #tags, #version_context

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PortGroup

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/intersight_client/models/port_group.rb', line 133

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::PortGroup` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'port.Group'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'port.Group'
  end

  if attributes.key?(:'transport')
    self.transport = attributes[:'transport']
  end

  if attributes.key?(:'equipment_shared_io_module')
    self.equipment_shared_io_module = attributes[:'equipment_shared_io_module']
  end

  if attributes.key?(:'equipment_switch_card')
    self.equipment_switch_card = attributes[:'equipment_switch_card']
  end

  if attributes.key?(:'ethernet_ports')
    if (value = attributes[:'ethernet_ports']).is_a?(Array)
      self.ethernet_ports = value
    end
  end

  if attributes.key?(:'fc_ports')
    if (value = attributes[:'fc_ports']).is_a?(Array)
      self.fc_ports = value
    end
  end

  if attributes.key?(:'inventory_device_info')
    self.inventory_device_info = attributes[:'inventory_device_info']
  end

  if attributes.key?(:'registered_device')
    self.registered_device = attributes[:'registered_device']
  end

  if attributes.key?(:'sub_groups')
    if (value = attributes[:'sub_groups']).is_a?(Array)
      self.sub_groups = value
    end
  end
end

Instance Attribute Details

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
 
# File 'lib/intersight_client/models/port_group.rb', line 20

def class_id
  @class_id
end

#equipment_shared_io_module ⇒ Object

Returns the value of attribute equipment_shared_io_module.



28
29
30
 
# File 'lib/intersight_client/models/port_group.rb', line 28

def equipment_shared_io_module
  @equipment_shared_io_module
end

#equipment_switch_card ⇒ Object

Returns the value of attribute equipment_switch_card.



30
31
32
 
# File 'lib/intersight_client/models/port_group.rb', line 30

def equipment_switch_card
  @equipment_switch_card
end

#ethernet_ports ⇒ Object

An array of relationships to etherPhysicalPort resources.



33
34
35
 
# File 'lib/intersight_client/models/port_group.rb', line 33

def ethernet_ports
  @ethernet_ports
end

#fc_ports ⇒ Object

An array of relationships to fcPhysicalPort resources.



36
37
38
 
# File 'lib/intersight_client/models/port_group.rb', line 36

def fc_ports
  @fc_ports
end

#inventory_device_info ⇒ Object

Returns the value of attribute inventory_device_info.



38
39
40
 
# File 'lib/intersight_client/models/port_group.rb', line 38

def inventory_device_info
  @inventory_device_info
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
 
# File 'lib/intersight_client/models/port_group.rb', line 23

def object_type
  @object_type
end

#registered_device ⇒ Object

Returns the value of attribute registered_device.



40
41
42
 
# File 'lib/intersight_client/models/port_group.rb', line 40

def registered_device
  @registered_device
end

#sub_groups ⇒ Object

An array of relationships to portSubGroup resources.



43
44
45
 
# File 'lib/intersight_client/models/port_group.rb', line 43

def sub_groups
  @sub_groups
end

#transport ⇒ Object

Type of port group. Values are Eth or Fc.



26
27
28
 
# File 'lib/intersight_client/models/port_group.rb', line 26

def transport
  @transport
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



89
90
91
 
# File 'lib/intersight_client/models/port_group.rb', line 89

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



84
85
86
 
# File 'lib/intersight_client/models/port_group.rb', line 84

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'transport' => :'Transport',
    :'equipment_shared_io_module' => :'EquipmentSharedIoModule',
    :'equipment_switch_card' => :'EquipmentSwitchCard',
    :'ethernet_ports' => :'EthernetPorts',
    :'fc_ports' => :'FcPorts',
    :'inventory_device_info' => :'InventoryDeviceInfo',
    :'registered_device' => :'RegisteredDevice',
    :'sub_groups' => :'SubGroups'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



279
280
281
 
# File 'lib/intersight_client/models/port_group.rb', line 279

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



119
120
121
122
123
124
 
# File 'lib/intersight_client/models/port_group.rb', line 119

def self.openapi_all_of
  [
  :'InventoryBase',
  :'PortGroupAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



127
128
129
 
# File 'lib/intersight_client/models/port_group.rb', line 127

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



110
111
112
113
114
115
116
 
# File 'lib/intersight_client/models/port_group.rb', line 110

def self.openapi_nullable
  Set.new([
    :'ethernet_ports',
    :'fc_ports',
    :'sub_groups'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/intersight_client/models/port_group.rb', line 94

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'transport' => :'String',
    :'equipment_shared_io_module' => :'EquipmentSharedIoModuleRelationship',
    :'equipment_switch_card' => :'EquipmentSwitchCardRelationship',
    :'ethernet_ports' => :'Array<EtherPhysicalPortRelationship>',
    :'fc_ports' => :'Array<FcPhysicalPortRelationship>',
    :'inventory_device_info' => :'InventoryDeviceInfoRelationship',
    :'registered_device' => :'AssetDeviceRegistrationRelationship',
    :'sub_groups' => :'Array<PortSubGroupRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/intersight_client/models/port_group.rb', line 249

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      transport == o.transport &&
      equipment_shared_io_module == o.equipment_shared_io_module &&
      equipment_switch_card == o.equipment_switch_card &&
      ethernet_ports == o.ethernet_ports &&
      fc_ports == o.fc_ports &&
      inventory_device_info == o.inventory_device_info &&
      registered_device == o.registered_device &&
      sub_groups == o.sub_groups && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/intersight_client/models/port_group.rb', line 310

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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 =~ /\A(true|t|yes|y|1)\z/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
    # models (e.g. Pet) or oneOf
    klass = IntersightClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/intersight_client/models/port_group.rb', line 381

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/intersight_client/models/port_group.rb', line 286

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  PortGroup.openapi_types.each_pair do |key, type|
    if attributes[PortGroup.attribute_map[key]].nil? && PortGroup.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[PortGroup.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[PortGroup.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[PortGroup.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[PortGroup.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


266
267
268
 
# File 'lib/intersight_client/models/port_group.rb', line 266

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



272
273
274
 
# File 'lib/intersight_client/models/port_group.rb', line 272

def hash
  [class_id, object_type, transport, equipment_shared_io_module, equipment_switch_card, ethernet_ports, fc_ports, inventory_device_info, registered_device, sub_groups].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/intersight_client/models/port_group.rb', line 202

def list_invalid_properties
  invalid_properties = super
  if @class_id.nil?
    invalid_properties.push('invalid value for "class_id", class_id cannot be nil.')
  end

  if @object_type.nil?
    invalid_properties.push('invalid value for "object_type", object_type cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



357
358
359
 
# File 'lib/intersight_client/models/port_group.rb', line 357

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/intersight_client/models/port_group.rb', line 363

def to_hash
  hash = super
  PortGroup.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = PortGroup.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



351
352
353
 
# File 'lib/intersight_client/models/port_group.rb', line 351

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



217
218
219
220
221
222
223
224
225
 
# File 'lib/intersight_client/models/port_group.rb', line 217

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["port.Group"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["port.Group"])
  return false unless object_type_validator.valid?(@object_type)
  true && super
end