Class: IntersightClient::PowerPolicy

Inherits:
PolicyAbstractPolicy show all
Defined in:
lib/intersight_client/models/power_policy.rb

Overview

Power Management policy models a configuration that can be applied to Chassis or Server to manage Power Related Features.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from PolicyAbstractPolicy

#description, #name

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

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/intersight_client/models/power_policy.rb', line 124

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

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

  if attributes.key?(:'allocated_budget')
    self.allocated_budget = attributes[:'allocated_budget']
  else
    self.allocated_budget = 0
  end

  if attributes.key?(:'power_profiling')
    self.power_profiling = attributes[:'power_profiling']
  else
    self.power_profiling = 'Enabled'
  end

  if attributes.key?(:'power_restore_state')
    self.power_restore_state = attributes[:'power_restore_state']
  else
    self.power_restore_state = 'AlwaysOff'
  end

  if attributes.key?(:'redundancy_mode')
    self.redundancy_mode = attributes[:'redundancy_mode']
  else
    self.redundancy_mode = 'Grid'
  end

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

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

Instance Attribute Details

#allocated_budget ⇒ Object

Sets the Allocated Power Budget of the System (in Watts). This field is only supported for Cisco UCS X series Chassis.



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

def allocated_budget
  @allocated_budget
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/power_policy.rb', line 20

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

def object_type
  @object_type
end

#organization ⇒ Object

Returns the value of attribute organization.



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

def organization
  @organization
end

#power_profiling ⇒ Object

Sets the Power Profiling of the Server. This field is only supported for Cisco UCS X series servers. * ‘Enabled` - Set the value to Enabled. * `Disabled` - Set the value to Disabled.



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

def power_profiling
  @power_profiling
end

#power_restore_state ⇒ Object

Sets the Power Restore State of the Server. This field is only supported for Cisco UCS X series servers. * ‘AlwaysOff` - Set the Power Restore Mode to Off. * `AlwaysOn` - Set the Power Restore Mode to On. * `LastState` - Set the Power Restore Mode to LastState.



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

def power_restore_state
  @power_restore_state
end

#profiles ⇒ Object

An array of relationships to policyAbstractConfigProfile resources.



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

def profiles
  @profiles
end

#redundancy_mode ⇒ Object

Sets the Power Redundancy of the System. N+2 mode is only supported for Cisco UCS X series Chassis. * ‘Grid` - Grid Mode requires two power sources. If one source fails, the surviving PSUs connected to the other source provides power to the chassis. * `NotRedundant` - Power Manager turns on the minimum number of PSUs required to support chassis power requirements. No Redundant PSUs are maintained. * `N+1` - Power Manager turns on the minimum number of PSUs required to support chassis power requirements plus one additional PSU for redundancy. * `N+2` - Power Manager turns on the minimum number of PSUs required to support chassis power requirements plus two additional PSU for redundancy. This Mode is only supported for UCS X series Chassis.



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

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



84
85
86
 
# File 'lib/intersight_client/models/power_policy.rb', line 84

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)



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

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.



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/intersight_client/models/power_policy.rb', line 65

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'allocated_budget' => :'AllocatedBudget',
    :'power_profiling' => :'PowerProfiling',
    :'power_restore_state' => :'PowerRestoreState',
    :'redundancy_mode' => :'RedundancyMode',
    :'organization' => :'Organization',
    :'profiles' => :'Profiles'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



324
325
326
 
# File 'lib/intersight_client/models/power_policy.rb', line 324

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



110
111
112
113
114
115
 
# File 'lib/intersight_client/models/power_policy.rb', line 110

def self.openapi_all_of
  [
  :'PolicyAbstractPolicy',
  :'PowerPolicyAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



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

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'profiles'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/intersight_client/models/power_policy.rb', line 89

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'allocated_budget' => :'Integer',
    :'power_profiling' => :'String',
    :'power_restore_state' => :'String',
    :'redundancy_mode' => :'String',
    :'organization' => :'OrganizationOrganizationRelationship',
    :'profiles' => :'Array<PolicyAbstractConfigProfileRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/intersight_client/models/power_policy.rb', line 296

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      allocated_budget == o.allocated_budget &&
      power_profiling == o.power_profiling &&
      power_restore_state == o.power_restore_state &&
      redundancy_mode == o.redundancy_mode &&
      organization == o.organization &&
      profiles == o.profiles && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/intersight_client/models/power_policy.rb', line 355

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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/intersight_client/models/power_policy.rb', line 426

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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/intersight_client/models/power_policy.rb', line 331

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


311
312
313
 
# File 'lib/intersight_client/models/power_policy.rb', line 311

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



317
318
319
 
# File 'lib/intersight_client/models/power_policy.rb', line 317

def hash
  [class_id, object_type, allocated_budget, power_profiling, power_restore_state, redundancy_mode, organization, profiles].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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/intersight_client/models/power_policy.rb', line 189

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

  if !@allocated_budget.nil? && @allocated_budget > 65535
    invalid_properties.push('invalid value for "allocated_budget", must be smaller than or equal to 65535.')
  end

  if !@allocated_budget.nil? && @allocated_budget < 0
    invalid_properties.push('invalid value for "allocated_budget", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



402
403
404
 
# File 'lib/intersight_client/models/power_policy.rb', line 402

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



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

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



396
397
398
 
# File 'lib/intersight_client/models/power_policy.rb', line 396

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/intersight_client/models/power_policy.rb', line 212

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["power.Policy"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["power.Policy"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@allocated_budget.nil? && @allocated_budget > 65535
  return false if !@allocated_budget.nil? && @allocated_budget < 0
  power_profiling_validator = EnumAttributeValidator.new('String', ["Enabled", "Disabled"])
  return false unless power_profiling_validator.valid?(@power_profiling)
  power_restore_state_validator = EnumAttributeValidator.new('String', ["AlwaysOff", "AlwaysOn", "LastState"])
  return false unless power_restore_state_validator.valid?(@power_restore_state)
  redundancy_mode_validator = EnumAttributeValidator.new('String', ["Grid", "NotRedundant", "N+1", "N+2"])
  return false unless redundancy_mode_validator.valid?(@redundancy_mode)
  true && super
end