Class: IntersightClient::HyperflexCluster

Inherits:
HyperflexBaseCluster show all
Defined in:
lib/intersight_client/models/hyperflex_cluster.rb

Overview

A HyperFlex cluster. Contains inventory information concerning the health, software versions, storage, and nodes of the cluster.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from HyperflexBaseCluster

#alarm_summary, #associated_profile, #capacity_runway, #child_clusters, #cluster_name, #cluster_purpose, #compute_node_count, #converged_node_count, #deployment_type, #drive_type, #hx_version, #hypervisor_version, #parent_cluster, #storage_capacity, #storage_node_count, #storage_utilization, #utilization_percentage, #utilization_trend_percentage

Attributes inherited from VirtualizationBaseCluster

#hypervisor_type, #identity, #memory_capacity, #name, #processor_capacity, #status, #total_cores

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 180

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#alarm ⇒ Object

An array of relationships to hyperflexAlarm resources.



53
54
55
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 53

def alarm
  @alarm
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.



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

def class_id
  @class_id
end

#cluster_type ⇒ Object

The storage type of this cluster (All Flash or Hybrid).



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

def cluster_type
  @cluster_type
end

#cluster_uuid ⇒ Object

The unique identifier for this HyperFlex cluster.



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

def cluster_uuid
  @cluster_uuid
end

#device_id ⇒ Object

The unique identifier of the device registration that represents this HyperFlex cluster’s connection to Intersight.



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

def device_id
  @device_id
end

#dns_servers ⇒ Object

Returns the value of attribute dns_servers.



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

def dns_servers
  @dns_servers
end

#flt_aggr ⇒ Object

The number of yellow (warning) and red (critical) alarms stored as an aggregate. The first 16 bits indicate the number of red alarms, and the last 16 bits contain the number of yellow alarms.



37
38
39
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 37

def flt_aggr
  @flt_aggr
end

#health ⇒ Object

Returns the value of attribute health.



55
56
57
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 55

def health
  @health
end

#hxdp_build_version ⇒ Object

The version and build number of the HyperFlex Data Platform for this cluster. After a cluster upgrade, this version string will be updated on the next inventory cycle to reflect the newly installed version.



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

def hxdp_build_version
  @hxdp_build_version
end

#license ⇒ Object

Returns the value of attribute license.



57
58
59
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 57

def license
  @license
end

#nodes ⇒ Object

An array of relationships to hyperflexNode resources.



60
61
62
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 60

def nodes
  @nodes
end

#ntp_servers ⇒ Object

Returns the value of attribute ntp_servers.



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

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

def object_type
  @object_type
end

#registered_device ⇒ Object

Returns the value of attribute registered_device.



62
63
64
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 62

def registered_device
  @registered_device
end

#storage_containers ⇒ Object

An array of relationships to storageHyperFlexStorageContainer resources.



65
66
67
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 65

def storage_containers
  @storage_containers
end

#summary ⇒ Object

Returns the value of attribute summary.



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

def summary
  @summary
end

#upgrade_status ⇒ Object

The upgrade status of the HyperFlex cluster. * ‘Unknown` - The upgrade status of the HyperFlex cluster could not be determined. * `Ok` - The upgrade of the HyperFlex cluster is complete. * `InProgress` - The upgrade of the HyperFlex cluster is in-progress. * `Failed` - The upgrade of the HyperFlex cluster has failed. * `Waiting` - The upgrade of the HyperFlex cluster is waiting to continue execution.



47
48
49
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 47

def upgrade_status
  @upgrade_status
end

#vm_count ⇒ Object

The number of virtual machines present on this cluster.



50
51
52
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 50

def vm_count
  @vm_count
end

#volumes ⇒ Object

An array of relationships to storageHyperFlexVolume resources.



68
69
70
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 68

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



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

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)



118
119
120
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 118

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.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 93

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'cluster_type' => :'ClusterType',
    :'cluster_uuid' => :'ClusterUuid',
    :'device_id' => :'DeviceId',
    :'dns_servers' => :'DnsServers',
    :'flt_aggr' => :'FltAggr',
    :'hxdp_build_version' => :'HxdpBuildVersion',
    :'ntp_servers' => :'NtpServers',
    :'summary' => :'Summary',
    :'upgrade_status' => :'UpgradeStatus',
    :'vm_count' => :'VmCount',
    :'alarm' => :'Alarm',
    :'health' => :'Health',
    :'license' => :'License',
    :'nodes' => :'Nodes',
    :'registered_device' => :'RegisteredDevice',
    :'storage_containers' => :'StorageContainers',
    :'volumes' => :'Volumes'
  }
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



391
392
393
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 391

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



166
167
168
169
170
171
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 166

def self.openapi_all_of
  [
  :'HyperflexBaseCluster',
  :'HyperflexClusterAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



174
175
176
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 174

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 153

def self.openapi_nullable
  Set.new([
    :'dns_servers',
    :'ntp_servers',
    :'summary',
    :'alarm',
    :'nodes',
    :'storage_containers',
    :'volumes'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 128

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'cluster_type' => :'Integer',
    :'cluster_uuid' => :'String',
    :'device_id' => :'String',
    :'dns_servers' => :'Array<String>',
    :'flt_aggr' => :'Integer',
    :'hxdp_build_version' => :'String',
    :'ntp_servers' => :'Array<String>',
    :'summary' => :'HyperflexSummary',
    :'upgrade_status' => :'String',
    :'vm_count' => :'Integer',
    :'alarm' => :'Array<HyperflexAlarmRelationship>',
    :'health' => :'HyperflexHealthRelationship',
    :'license' => :'HyperflexLicenseRelationship',
    :'nodes' => :'Array<HyperflexNodeRelationship>',
    :'registered_device' => :'AssetDeviceRegistrationRelationship',
    :'storage_containers' => :'Array<StorageHyperFlexStorageContainerRelationship>',
    :'volumes' => :'Array<StorageHyperFlexVolumeRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 352

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      cluster_type == o.cluster_type &&
      cluster_uuid == o.cluster_uuid &&
      device_id == o.device_id &&
      dns_servers == o.dns_servers &&
      flt_aggr == o.flt_aggr &&
      hxdp_build_version == o.hxdp_build_version &&
      ntp_servers == o.ntp_servers &&
      summary == o.summary &&
      upgrade_status == o.upgrade_status &&
      vm_count == o.vm_count &&
      alarm == o.alarm &&
      health == o.health &&
      license == o.license &&
      nodes == o.nodes &&
      registered_device == o.registered_device &&
      storage_containers == o.storage_containers &&
      volumes == o.volumes && 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



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 422

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



493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 493

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



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 398

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


378
379
380
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 378

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



384
385
386
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 384

def hash
  [class_id, object_type, cluster_type, cluster_uuid, device_id, dns_servers, flt_aggr, hxdp_build_version, ntp_servers, summary, upgrade_status, vm_count, alarm, health, license, nodes, registered_device, storage_containers, volumes].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



293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 293

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



469
470
471
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 469

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



475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 475

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



463
464
465
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 463

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



308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/intersight_client/models/hyperflex_cluster.rb', line 308

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["hyperflex.Cluster"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["hyperflex.Cluster"])
  return false unless object_type_validator.valid?(@object_type)
  upgrade_status_validator = EnumAttributeValidator.new('String', ["Unknown", "Ok", "InProgress", "Failed", "Waiting"])
  return false unless upgrade_status_validator.valid?(@upgrade_status)
  true && super
end