Class: IntersightClient::HyperflexHealthCheckDefinition

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

Overview

HyperFlex health check definition metadata.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
290
291
292
293
294
295
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 184

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'minimum_hyper_flex_version')
    self.minimum_hyper_flex_version = attributes[:'minimum_hyper_flex_version']
  else
    self.minimum_hyper_flex_version = '3.0'
  end

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

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

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

  if attributes.key?(:'script_execution_mode')
    self.script_execution_mode = attributes[:'script_execution_mode']
  else
    self.script_execution_mode = 'ON_DEMAND'
  end

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

  if attributes.key?(:'supported_hypervisor_type')
    self.supported_hypervisor_type = attributes[:'supported_hypervisor_type']
  else
    self.supported_hypervisor_type = 'All'
  end

  if attributes.key?(:'target_execution_type')
    self.target_execution_type = attributes[:'target_execution_type']
  else
    self.target_execution_type = 'EXECUTE_ON_LEADER_NODE'
  end

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

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

Instance Attribute Details

#category ⇒ Object

Category that the health check belongs to.



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

def category
  @category
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_health_check_definition.rb', line 20

def class_id
  @class_id
end

#common_causes ⇒ Object

Static information detailing the common causes for the health check failure.



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

def common_causes
  @common_causes
end

#configuration ⇒ Object

Execution configuration fo the health check script.



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

def configuration
  @configuration
end

#default_health_check_script_info ⇒ Object

Returns the value of attribute default_health_check_script_info.



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

def default_health_check_script_info
  @default_health_check_script_info
end

#description ⇒ Object

Description of the health check definition.



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

def description
  @description
end

#health_check_script_infos ⇒ Object

Returns the value of attribute health_check_script_infos.



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

def health_check_script_infos
  @health_check_script_infos
end

#health_impact ⇒ Object

Static information detailing the health impact of the health check failure.



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

def health_impact
  @health_impact
end

#internal_name ⇒ Object

Internal name of the health check definition.



45
46
47
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 45

def internal_name
  @internal_name
end

#minimum_hyper_flex_version ⇒ Object

Minimum HyperFlex version that the check is supported on. Defaults to version 3.0.1.



48
49
50
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 48

def minimum_hyper_flex_version
  @minimum_hyper_flex_version
end

#name ⇒ Object

Name of the health check definition.



51
52
53
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 51

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.



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

def object_type
  @object_type
end

#reference ⇒ Object

Static information containing additional reference for the health check.



54
55
56
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 54

def reference
  @reference
end

#resolution ⇒ Object

Static information detailing the possible remediation actions that can be taken to remedy the health check failure.



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

def resolution
  @resolution
end

#script_execution_mode ⇒ Object

Execution mode of the health script on the HyperFlex cluster. * ON_DEMAND - Execute the health check on-demand. * SCHEDULED - Execute the health check on a scheduled interval.



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

def script_execution_mode
  @script_execution_mode
end

#script_execution_on_compute_nodes ⇒ Object

Indicates if the script needs to be executed on HyperFlex compute nodes. | Typically, scripts are only executed on the storage Nodes.



63
64
65
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 63

def script_execution_on_compute_nodes
  @script_execution_on_compute_nodes
end

#supported_hypervisor_type ⇒ Object

Hypervisor type that the Health Check is supported on (All, if it is hypervisor agnostic). * All - The Health Check is hypervisor-agnostic. * ESXi - The Health Check is supported only on Vmware ESXi hypervisor of any version. * “ - The Health Check is supported only on Cisco HyperFlexAp platform. * IWE - The Health Check is supported only on Cisco IWE platform. * HyperV - The Health Check is supported only on Microsoft HyperV hypervisor.



66
67
68
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 66

def supported_hypervisor_type
  @supported_hypervisor_type
end

#target_execution_type ⇒ Object

Indicates whether the health check is executed only on the leader node, or on all nodes in the HyperFlex cluster. * EXECUTE_ON_LEADER_NODE - Execute the health check script only on the HyperFlex cluster’s leader node. * EXECUTE_ON_ALL_NODES - Execute health check on all nodes and aggregate the results. * EXECUTE_ON_ALL_NODES_AND_AGGREGATE - Execute the health check on all Nodes and perform custom aggregation.



69
70
71
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 69

def target_execution_type
  @target_execution_type
end

#timeout ⇒ Object

Health check script execution timeout.



72
73
74
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 72

def timeout
  @timeout
end

#unsupported_hyper_flex_versions ⇒ Object

Returns the value of attribute unsupported_hyper_flex_versions.



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

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



130
131
132
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 130

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)



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

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.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 99

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'category' => :'Category',
    :'common_causes' => :'CommonCauses',
    :'configuration' => :'Configuration',
    :'default_health_check_script_info' => :'DefaultHealthCheckScriptInfo',
    :'description' => :'Description',
    :'health_check_script_infos' => :'HealthCheckScriptInfos',
    :'health_impact' => :'HealthImpact',
    :'internal_name' => :'InternalName',
    :'minimum_hyper_flex_version' => :'MinimumHyperFlexVersion',
    :'name' => :'Name',
    :'reference' => :'Reference',
    :'resolution' => :'Resolution',
    :'script_execution_mode' => :'ScriptExecutionMode',
    :'script_execution_on_compute_nodes' => :'ScriptExecutionOnComputeNodes',
    :'supported_hypervisor_type' => :'SupportedHypervisorType',
    :'target_execution_type' => :'TargetExecutionType',
    :'timeout' => :'Timeout',
    :'unsupported_hyper_flex_versions' => :'UnsupportedHyperFlexVersions'
  }
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



422
423
424
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 422

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



170
171
172
173
174
175
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 170

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



178
179
180
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 178

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



161
162
163
164
165
166
167
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 161

def self.openapi_nullable
  Set.new([
    :'default_health_check_script_info',
    :'health_check_script_infos',
    :'unsupported_hyper_flex_versions'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 135

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'category' => :'String',
    :'common_causes' => :'String',
    :'configuration' => :'String',
    :'default_health_check_script_info' => :'HyperflexHealthCheckScriptInfo',
    :'description' => :'String',
    :'health_check_script_infos' => :'Array<HyperflexHealthCheckScriptInfo>',
    :'health_impact' => :'String',
    :'internal_name' => :'String',
    :'minimum_hyper_flex_version' => :'String',
    :'name' => :'String',
    :'reference' => :'String',
    :'resolution' => :'String',
    :'script_execution_mode' => :'String',
    :'script_execution_on_compute_nodes' => :'Boolean',
    :'supported_hypervisor_type' => :'String',
    :'target_execution_type' => :'String',
    :'timeout' => :'Integer',
    :'unsupported_hyper_flex_versions' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 382

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      category == o.category &&
      common_causes == o.common_causes &&
      configuration == o.configuration &&
      default_health_check_script_info == o.default_health_check_script_info &&
      description == o.description &&
      health_check_script_infos == o.health_check_script_infos &&
      health_impact == o.health_impact &&
      internal_name == o.internal_name &&
      minimum_hyper_flex_version == o.minimum_hyper_flex_version &&
      name == o.name &&
      reference == o.reference &&
      resolution == o.resolution &&
      script_execution_mode == o.script_execution_mode &&
      script_execution_on_compute_nodes == o.script_execution_on_compute_nodes &&
      supported_hypervisor_type == o.supported_hypervisor_type &&
      target_execution_type == o.target_execution_type &&
      timeout == o.timeout &&
      unsupported_hyper_flex_versions == o.unsupported_hyper_flex_versions && 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



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 453

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



524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 524

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



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 429

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


409
410
411
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 409

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



415
416
417
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 415

def hash
  [class_id, object_type, category, common_causes, configuration, default_health_check_script_info, description, health_check_script_infos, health_impact, internal_name, minimum_hyper_flex_version, name, reference, resolution, script_execution_mode, script_execution_on_compute_nodes, supported_hypervisor_type, target_execution_type, timeout, unsupported_hyper_flex_versions].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



299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 299

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



500
501
502
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 500

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



506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 506

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



494
495
496
 
# File 'lib/intersight_client/models/hyperflex_health_check_definition.rb', line 494

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



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

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["hyperflex.HealthCheckDefinition"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["hyperflex.HealthCheckDefinition"])
  return false unless object_type_validator.valid?(@object_type)
  script_execution_mode_validator = EnumAttributeValidator.new('String', ["ON_DEMAND", "SCHEDULED"])
  return false unless script_execution_mode_validator.valid?(@script_execution_mode)
  supported_hypervisor_type_validator = EnumAttributeValidator.new('String', ["All", "ESXi", "", "IWE", "HyperV"])
  return false unless supported_hypervisor_type_validator.valid?(@supported_hypervisor_type)
  target_execution_type_validator = EnumAttributeValidator.new('String', ["EXECUTE_ON_LEADER_NODE", "EXECUTE_ON_ALL_NODES", "EXECUTE_ON_ALL_NODES_AND_AGGREGATE"])
  return false unless target_execution_type_validator.valid?(@target_execution_type)
  true && super
end