Class: IntersightClient::ManagementEntity

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

Overview

Logical representation that captures the role of each Fabric Interconnect in UCS Manager.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/intersight_client/models/management_entity.rb', line 131

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'registered_device')
    self.registered_device = attributes[:'registered_device']
  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/management_entity.rb', line 20

def class_id
  @class_id
end

#cluster_link_state ⇒ Object

Cluster link state between the Fabric Interconnects.



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

def cluster_link_state
  @cluster_link_state
end

#cluster_readiness ⇒ Object

Cluster readiness of the Fabric Interconnect.



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

def cluster_readiness
  @cluster_readiness
end

#cluster_state ⇒ Object

Cluster state of the Fabric Interconnect.



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

def cluster_state
  @cluster_state
end

#entity_id ⇒ Object

Identity of the Fabric Interconnect - A/B.



35
36
37
 
# File 'lib/intersight_client/models/management_entity.rb', line 35

def entity_id
  @entity_id
end

#inventory_device_info ⇒ Object

Returns the value of attribute inventory_device_info.



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

def inventory_device_info
  @inventory_device_info
end

#leadership ⇒ Object

Role (Primary / Subordinate) of the Fabric Interconnect.



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

def leadership
  @leadership
end

#network_element ⇒ Object

Returns the value of attribute network_element.



42
43
44
 
# File 'lib/intersight_client/models/management_entity.rb', line 42

def network_element
  @network_element
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/management_entity.rb', line 23

def object_type
  @object_type
end

#registered_device ⇒ Object

Returns the value of attribute registered_device.



44
45
46
 
# File 'lib/intersight_client/models/management_entity.rb', line 44

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



90
91
92
 
# File 'lib/intersight_client/models/management_entity.rb', line 90

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)



85
86
87
 
# File 'lib/intersight_client/models/management_entity.rb', line 85

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'cluster_link_state' => :'ClusterLinkState',
    :'cluster_readiness' => :'ClusterReadiness',
    :'cluster_state' => :'ClusterState',
    :'entity_id' => :'EntityId',
    :'leadership' => :'Leadership',
    :'inventory_device_info' => :'InventoryDeviceInfo',
    :'network_element' => :'NetworkElement',
    :'registered_device' => :'RegisteredDevice'
  }
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



271
272
273
 
# File 'lib/intersight_client/models/management_entity.rb', line 271

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



117
118
119
120
121
122
 
# File 'lib/intersight_client/models/management_entity.rb', line 117

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



125
126
127
 
# File 'lib/intersight_client/models/management_entity.rb', line 125

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'cluster_link_state' => :'String',
    :'cluster_readiness' => :'String',
    :'cluster_state' => :'String',
    :'entity_id' => :'String',
    :'leadership' => :'String',
    :'inventory_device_info' => :'InventoryDeviceInfoRelationship',
    :'network_element' => :'NetworkElementRelationship',
    :'registered_device' => :'AssetDeviceRegistrationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      cluster_link_state == o.cluster_link_state &&
      cluster_readiness == o.cluster_readiness &&
      cluster_state == o.cluster_state &&
      entity_id == o.entity_id &&
      leadership == o.leadership &&
      inventory_device_info == o.inventory_device_info &&
      network_element == o.network_element &&
      registered_device == o.registered_device && 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



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

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



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

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



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

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


258
259
260
 
# File 'lib/intersight_client/models/management_entity.rb', line 258

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



264
265
266
 
# File 'lib/intersight_client/models/management_entity.rb', line 264

def hash
  [class_id, object_type, cluster_link_state, cluster_readiness, cluster_state, entity_id, leadership, inventory_device_info, network_element, registered_device].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



194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/intersight_client/models/management_entity.rb', line 194

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



349
350
351
 
# File 'lib/intersight_client/models/management_entity.rb', line 349

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



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

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



343
344
345
 
# File 'lib/intersight_client/models/management_entity.rb', line 343

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



209
210
211
212
213
214
215
216
217
 
# File 'lib/intersight_client/models/management_entity.rb', line 209

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