Class: IntersightClient::FabricPortRole

Inherits:
MoBaseMo
  • Object
show all
Defined in:
lib/intersight_client/models/fabric_port_role.rb

Overview

Configuration object sent by user to apply on a port. A common port naming convention is to identify a port as "slotId/portId" when no breakout port is configured and "slotId/aggregatePortId/portId" when a breakout port is configured.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

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 = {}) ⇒ FabricPortRole

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::FabricPortRole` 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']
  end

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

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

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

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

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

Instance Attribute Details

#aggregate_port_id ⇒ Object

Breakout port Identifier of the Switch Interface. When a port is not configured as a breakout port, the aggregatePortId is set to 0, and unused. When a port is configured as a breakout port, the ‘aggregatePortId’ port number as labeled on the equipment, e.g. the id of the port on the switch.



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

def aggregate_port_id
  @aggregate_port_id
end

#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. The enum values provides the list of concrete types that can be instantiated from this abstract type.



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

def class_id
  @class_id
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property. The enum values provides the list of concrete types that can be instantiated from this abstract type.



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

def object_type
  @object_type
end

#port_id ⇒ Object

Port Identifier of the Switch/FEX/Chassis Interface. When a port is not configured as a breakout port, the portId is the port number as labeled on the equipment, e.g. the id of the port on the switch, FEX or chassis. When a port is configured as a breakout port, the ‘portId’ represents the port id on the fanout side of the breakout cable.



29
30
31
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 29

def port_id
  @port_id
end

#port_policy ⇒ Object

Returns the value of attribute port_policy.



34
35
36
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 34

def port_policy
  @port_policy
end

#slot_id ⇒ Object

Slot Identifier of the Switch/FEX/Chassis Interface.



32
33
34
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 32

def slot_id
  @slot_id
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)



76
77
78
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 76

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)



71
72
73
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 71

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.



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 59

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'aggregate_port_id' => :'AggregatePortId',
    :'port_id' => :'PortId',
    :'slot_id' => :'SlotId',
    :'port_policy' => :'PortPolicy'
  }
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



301
302
303
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 301

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



99
100
101
102
103
104
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 99

def self.openapi_all_of
  [
  :'FabricPortRoleAllOf',
  :'MoBaseMo'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



107
108
109
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 107

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



93
94
95
96
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 93

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 81

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'aggregate_port_id' => :'Integer',
    :'port_id' => :'Integer',
    :'slot_id' => :'Integer',
    :'port_policy' => :'FabricPortPolicyRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



275
276
277
278
279
280
281
282
283
284
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 275

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      aggregate_port_id == o.aggregate_port_id &&
      port_id == o.port_id &&
      slot_id == o.slot_id &&
      port_policy == o.port_policy && 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



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

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



403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 403

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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 308

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  FabricPortRole.openapi_types.each_pair do |key, type|
    if attributes[FabricPortRole.attribute_map[key]].nil? && FabricPortRole.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[FabricPortRole.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[FabricPortRole.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[FabricPortRole.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[FabricPortRole.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


288
289
290
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 288

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



294
295
296
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 294

def hash
  [class_id, object_type, aggregate_port_id, port_id, slot_id, port_policy].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



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

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

  if !@aggregate_port_id.nil? && @aggregate_port_id > 108
    invalid_properties.push('invalid value for "aggregate_port_id", must be smaller than or equal to 108.')
  end

  if !@aggregate_port_id.nil? && @aggregate_port_id < 0
    invalid_properties.push('invalid value for "aggregate_port_id", must be greater than or equal to 0.')
  end

  if !@port_id.nil? && @port_id > 108
    invalid_properties.push('invalid value for "port_id", must be smaller than or equal to 108.')
  end

  if !@port_id.nil? && @port_id < 1
    invalid_properties.push('invalid value for "port_id", must be greater than or equal to 1.')
  end

  if !@slot_id.nil? && @slot_id > 5
    invalid_properties.push('invalid value for "slot_id", must be smaller than or equal to 5.')
  end

  if !@slot_id.nil? && @slot_id < 1
    invalid_properties.push('invalid value for "slot_id", must be greater than or equal to 1.')
  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



379
380
381
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 379

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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 385

def to_hash
  hash = super
  FabricPortRole.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = FabricPortRole.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



373
374
375
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 373

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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/intersight_client/models/fabric_port_role.rb', line 195

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["fabric.ApplianceRole", "fabric.FcUplinkRole", "fabric.FcoeUplinkRole", "fabric.ServerRole", "fabric.UplinkRole"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["fabric.ApplianceRole", "fabric.FcUplinkRole", "fabric.FcoeUplinkRole", "fabric.ServerRole", "fabric.UplinkRole"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@aggregate_port_id.nil? && @aggregate_port_id > 108
  return false if !@aggregate_port_id.nil? && @aggregate_port_id < 0
  return false if !@port_id.nil? && @port_id > 108
  return false if !@port_id.nil? && @port_id < 1
  return false if !@slot_id.nil? && @slot_id > 5
  return false if !@slot_id.nil? && @slot_id < 1
  true && super
end