Class: IntersightClient::FabricElementIdentity

Inherits:
EquipmentIdentity show all
Defined in:
lib/intersight_client/models/fabric_element_identity.rb

Overview

Identity object that uniquely represents a network element object under the domain.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from EquipmentIdentity

#admin_action, #admin_action_state, #identifier, #lifecycle, #model, #registered_device, #serial, #vendor

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

  if attributes.key?(:'replacement_type')
    self.replacement_type = attributes[:'replacement_type']
  else
    self.replacement_type = 'None'
  end

  if attributes.key?(:'switch_id')
    self.switch_id = attributes[:'switch_id']
  else
    self.switch_id = 'A'
  end

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

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

Instance Attribute Details

#class_idObject

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/fabric_element_identity.rb', line 20

def class_id
  @class_id
end

#domainObject

Name of the Fabric Interconnect domain.



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

def domain
  @domain
end

#network_elementObject

Returns the value of attribute network_element.



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

def network_element
  @network_element
end

#object_typeObject

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/fabric_element_identity.rb', line 23

def object_type
  @object_type
end

#replacement_targetObject

Returns the value of attribute replacement_target.



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

def replacement_target
  @replacement_target
end

#replacement_typeObject

Replacement type specifies whether it is single FI or domain replacement. * None - The default action is none. * Individual - Replacement of single network element. * Domain - Domain indicates the replacement of Fabric Interconnect domain.



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

def replacement_type
  @replacement_type
end

#switch_idObject

Switch Identifier that uniquely represents the fabric object. * A - Switch Identifier of Fabric Interconnect A. * B - Switch Identifier of Fabric Interconnect B.



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

def switch_id
  @switch_id
end

Class Method Details

.acceptable_attribute_mapObject

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



79
80
81
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 79

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

.acceptable_attributesObject

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



74
75
76
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 74

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

.attribute_mapObject

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



61
62
63
64
65
66
67
68
69
70
71
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 61

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'domain' => :'Domain',
    :'replacement_type' => :'ReplacementType',
    :'switch_id' => :'SwitchId',
    :'network_element' => :'NetworkElement',
    :'replacement_target' => :'ReplacementTarget'
  }
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



270
271
272
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 270

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

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



103
104
105
106
107
108
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 103

def self.openapi_all_of
  [
  :'EquipmentIdentity',
  :'FabricElementIdentityAllOf'
  ]
end

.openapi_discriminator_nameObject

discriminator’s property name in OpenAPI v3



111
112
113
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 111

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullableObject

List of attributes with nullable: true



97
98
99
100
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 97

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

.openapi_typesObject

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 84

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'domain' => :'String',
    :'replacement_type' => :'String',
    :'switch_id' => :'String',
    :'network_element' => :'NetworkElementRelationship',
    :'replacement_target' => :'NetworkElementRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



243
244
245
246
247
248
249
250
251
252
253
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 243

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      domain == o.domain &&
      replacement_type == o.replacement_type &&
      switch_id == o.switch_id &&
      network_element == o.network_element &&
      replacement_target == o.replacement_target && 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



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

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



372
373
374
375
376
377
378
379
380
381
382
383
384
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 372

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 277

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


257
258
259
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 257

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



263
264
265
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 263

def hash
  [class_id, object_type, domain, replacement_type, switch_id, network_element, replacement_target].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



172
173
174
175
176
177
178
179
180
181
182
183
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 172

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_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



348
349
350
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 348

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



354
355
356
357
358
359
360
361
362
363
364
365
366
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 354

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

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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



342
343
344
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 342

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



187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'lib/intersight_client/models/fabric_element_identity.rb', line 187

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["fabric.ElementIdentity"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["fabric.ElementIdentity"])
  return false unless object_type_validator.valid?(@object_type)
  replacement_type_validator = EnumAttributeValidator.new('String', ["None", "Individual", "Domain"])
  return false unless replacement_type_validator.valid?(@replacement_type)
  switch_id_validator = EnumAttributeValidator.new('String', ["A", "B"])
  return false unless switch_id_validator.valid?(@switch_id)
  true && super
end