Class: IntersightClient::VirtualizationBaseCluster

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

Overview

Common attributes of a cluster of resources within a datacenter. A cluster is a convenient grouping of resources such as Host, Datastore, etc.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
177
178
179
180
181
182
183
184
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 129

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

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

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

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

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

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = 'Unknown'
  end

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

def class_id
  @class_id
end

#hypervisor_type ⇒ Object

Identifies the broad type of the underlying hypervisor. * ESXi - The hypervisor running on the HyperFlex cluster is a Vmware ESXi hypervisor of any version. * HyperFlexAp - The hypervisor of the virtualization platform is Cisco HyperFlex Application Platform. * IWE - The hypervisor of the virtualization platform is Cisco Intersight Workload Engine. * Hyper-V - The hypervisor running on the HyperFlex cluster is Microsoft Hyper-V. * Unknown - The hypervisor running on the HyperFlex cluster is not known.



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

def hypervisor_type
  @hypervisor_type
end

#identity ⇒ Object

The internally generated identity of this cluster. This entity is not manipulated by users. It aids in uniquely identifying the cluster object. In case of VMware, this is a MOR (managed object reference).



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

def identity
  @identity
end

#memory_capacity ⇒ Object

Returns the value of attribute memory_capacity.



31
32
33
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 31

def memory_capacity
  @memory_capacity
end

#name ⇒ Object

The user-provided name for this cluster to facilitate identification.



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

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

def object_type
  @object_type
end

#processor_capacity ⇒ Object

Returns the value of attribute processor_capacity.



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

def processor_capacity
  @processor_capacity
end

#status ⇒ Object

Cluster health status as reported by the hypervisor platform. * Unknown - Entity status is unknown. * Degraded - State is degraded, and might impact normal operation of the entity. * Critical - Entity is in a critical state, impacting operations. * Ok - Entity status is in a stable state, operating normally.



39
40
41
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 39

def status
  @status
end

#total_cores ⇒ Object

Total number of CPU cores in this cluster. It is a cumulative number across all hosts in the cluster.



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

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



87
88
89
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 87

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)



82
83
84
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 82

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'hypervisor_type' => :'HypervisorType',
    :'identity' => :'Identity',
    :'memory_capacity' => :'MemoryCapacity',
    :'name' => :'Name',
    :'processor_capacity' => :'ProcessorCapacity',
    :'status' => :'Status',
    :'total_cores' => :'TotalCores'
  }
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



305
306
307
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 305

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



115
116
117
118
119
120
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 115

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



123
124
125
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 123

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
111
112
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 107

def self.openapi_nullable
  Set.new([
    :'memory_capacity',
    :'processor_capacity',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 92

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'hypervisor_type' => :'String',
    :'identity' => :'String',
    :'memory_capacity' => :'VirtualizationMemoryCapacity',
    :'name' => :'String',
    :'processor_capacity' => :'VirtualizationComputeCapacity',
    :'status' => :'String',
    :'total_cores' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 276

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      hypervisor_type == o.hypervisor_type &&
      identity == o.identity &&
      memory_capacity == o.memory_capacity &&
      name == o.name &&
      processor_capacity == o.processor_capacity &&
      status == o.status &&
      total_cores == o.total_cores && 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



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
370
371
372
373
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 336

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



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 407

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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 312

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


292
293
294
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 292

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



298
299
300
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 298

def hash
  [class_id, object_type, hypervisor_type, identity, memory_capacity, name, processor_capacity, status, total_cores].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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 188

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

  pattern = Regexp.new(/^[a-zA-Z0-9]+[\sa-zA-Z0-9_-]{1,32}$/)
  if !@name.nil? && @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  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



383
384
385
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 383

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



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 389

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



377
378
379
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 377

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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/intersight_client/models/virtualization_base_cluster.rb', line 208

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["hyperflex.Cluster", "hyperflex.HxapCluster", "virtualization.VmwareCluster"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["hyperflex.Cluster", "hyperflex.HxapCluster", "virtualization.VmwareCluster"])
  return false unless object_type_validator.valid?(@object_type)
  hypervisor_type_validator = EnumAttributeValidator.new('String', ["ESXi", "HyperFlexAp", "IWE", "Hyper-V", "Unknown"])
  return false unless hypervisor_type_validator.valid?(@hypervisor_type)
  return false if !@name.nil? && @name !~ Regexp.new(/^[a-zA-Z0-9]+[\sa-zA-Z0-9_-]{1,32}$/)
  status_validator = EnumAttributeValidator.new('String', ["Unknown", "Degraded", "Critical", "Ok"])
  return false unless status_validator.valid?(@status)
  true && super
end