Class: IntersightClient::ApplianceUpgradePolicy

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

Overview

UpgradePolicy stores the Intersight Appliance’s software upgrade policy. UpgradePolicy is a sinlgeton managed object. A default upgrade policy is created during the Intersight Appliance setup, and it is configured with an automatic upgrade policy. Automatic upgrade policy lets the system start software upgrade after a pre-defined number of seconds set in the software manifest. Scheduled upgrade policy lets the user start software upgrade at a specified schedule. However, scheduled time cannot be beyond the time limit enforced by the upgrade grace period set in the software manifest.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 143

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

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

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

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

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

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

  if attributes.key?(:'enable_meta_data_sync')
    self.enable_meta_data_sync = attributes[:'enable_meta_data_sync']
  else
    self.enable_meta_data_sync = true
  end

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

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

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

  if attributes.key?(:'software_download_type')
    self.software_download_type = attributes[:'software_download_type']
  else
    self.software_download_type = 'connected'
  end

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

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



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

def 
  @account
end

#auto_upgrade ⇒ Object

Indicates if the upgrade service is set to automatically start the software upgrade or not. If autoUpgrade is true, then the value of the schedule field is ignored.



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

def auto_upgrade
  @auto_upgrade
end

#blackout_dates_enabled ⇒ Object

If enabled, allows the user to define a blackout period during which the appliance will not be upgraded.



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

def blackout_dates_enabled
  @blackout_dates_enabled
end

#blackout_end_date ⇒ Object

End date of the black out period.



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

def blackout_end_date
  @blackout_end_date
end

#blackout_start_date ⇒ Object

Start date of the black out period. The appliance will not be upgraded during this period.



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

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

def class_id
  @class_id
end

#enable_meta_data_sync ⇒ Object

Indicates if the updated metadata files should be synced immediately or at the next upgrade.



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

def enable_meta_data_sync
  @enable_meta_data_sync
end

#is_synced ⇒ Object

Flag to indicate software upgrade setting is synchronized with Intersight SaaS.



41
42
43
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 41

def is_synced
  @is_synced
end

#manual_installation_start_time ⇒ Object

Intersight Appliance manual upgrade start time.



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

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

def object_type
  @object_type
end

#schedule ⇒ Object

Returns the value of attribute schedule.



46
47
48
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 46

def schedule
  @schedule
end

#software_download_type ⇒ Object

SoftwareDownloadType is used to indicate the kind of software download. * connected - Indicates if the upgrade service is set to upload software to latest version automatically. * manual - Indicates if the upgrade service is set to upload software to user picked verison manually .



49
50
51
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 49

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



99
100
101
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 99

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)



94
95
96
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 94

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.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 76

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'auto_upgrade' => :'AutoUpgrade',
    :'blackout_dates_enabled' => :'BlackoutDatesEnabled',
    :'blackout_end_date' => :'BlackoutEndDate',
    :'blackout_start_date' => :'BlackoutStartDate',
    :'enable_meta_data_sync' => :'EnableMetaDataSync',
    :'is_synced' => :'IsSynced',
    :'manual_installation_start_time' => :'ManualInstallationStartTime',
    :'schedule' => :'Schedule',
    :'software_download_type' => :'SoftwareDownloadType',
    :'account' => :'Account'
  }
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



309
310
311
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 309

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



129
130
131
132
133
134
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 129

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



137
138
139
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 137

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
126
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 122

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

.openapi_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 104

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'auto_upgrade' => :'Boolean',
    :'blackout_dates_enabled' => :'Boolean',
    :'blackout_end_date' => :'Time',
    :'blackout_start_date' => :'Time',
    :'enable_meta_data_sync' => :'Boolean',
    :'is_synced' => :'Boolean',
    :'manual_installation_start_time' => :'Time',
    :'schedule' => :'OnpremSchedule',
    :'software_download_type' => :'String',
    :'account' => :'IamAccountRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 277

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      auto_upgrade == o.auto_upgrade &&
      blackout_dates_enabled == o.blackout_dates_enabled &&
      blackout_end_date == o.blackout_end_date &&
      blackout_start_date == o.blackout_start_date &&
      enable_meta_data_sync == o.enable_meta_data_sync &&
      is_synced == o.is_synced &&
      manual_installation_start_time == o.manual_installation_start_time &&
      schedule == o.schedule &&
      software_download_type == o.software_download_type &&
       == o. && 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



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
374
375
376
377
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 340

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



411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 411

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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 316

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


296
297
298
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 296

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



302
303
304
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 302

def hash
  [class_id, object_type, auto_upgrade, blackout_dates_enabled, blackout_end_date, blackout_start_date, enable_meta_data_sync, is_synced, manual_installation_start_time, schedule, software_download_type, ].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



218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 218

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



387
388
389
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 387

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



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 393

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



381
382
383
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 381

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



233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/intersight_client/models/appliance_upgrade_policy.rb', line 233

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["appliance.UpgradePolicy"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["appliance.UpgradePolicy"])
  return false unless object_type_validator.valid?(@object_type)
  software_download_type_validator = EnumAttributeValidator.new('String', ["connected", "manual"])
  return false unless software_download_type_validator.valid?(@software_download_type)
  true && super
end