Class: IntersightClient::ApplianceSetupInfo

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

Overview

SetupInfo will have only one managed object. SetupInfo managed object is to keep track of the Intersight Appliance’s setup information and guide the UI through the initial configuration of the Intersight Appliance. The SetupInfo managed object is created during the Intersight Appliance setup. The Intersight UI uses this object to store the initial configuration states that the user has completed. If the user closes the Intersight UI without finishing all the initial configuration, then the Intersight UI will use this managed object to display the next configuration that the user needs to complete when the user uses the Intersight Appliance next time.

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

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
215
216
 
# File 'lib/intersight_client/models/appliance_setup_info.rb', line 143

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

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

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

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

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

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

  if attributes.key?(:'deployment_mode')
    self.deployment_mode = attributes[:'deployment_mode']
  else
    self.deployment_mode = 'Connected'
  end

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



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

def 
  @account
end

#backup_version ⇒ Object

The version of Intersight Appliance backup which can restore to.



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

def backup_version
  @backup_version
end

#build_type ⇒ Object

Build type of the Intersight Appliance setup (e.g. release or debug).



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

def build_type
  @build_type
end

#capabilities ⇒ Object

Returns the value of attribute capabilities.



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

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

def class_id
  @class_id
end

#cloud_url ⇒ Object

URL of the Intersight to which this Intersight Appliance is connected to.



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

def cloud_url
  @cloud_url
end

#deployment_mode ⇒ Object

Indicates where Intersight Appliance is installed in air-gapped or connected mode. In connected mode, Intersight Appliance is claimed by Intesight SaaS. In air-gapped mode, Intersight Appliance does not connect to any Cisco services. * Connected - In connected mode, Intersight Appliance connects to Intersight SaaS and other cisco.com services. * Private - In private mode, Intersight Appliance does not connect to Intersight SaaS or any cisco.com services.



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

def deployment_mode
  @deployment_mode
end

#end_time ⇒ Object

End date of the Intersight Appliance’s initial setup.



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

def end_time
  @end_time
end

#latest_version ⇒ Object

The most recent version which Intersight Appliance can upgrade to.



43
44
45
 
# File 'lib/intersight_client/models/appliance_setup_info.rb', line 43

def latest_version
  @latest_version
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_setup_info.rb', line 23

def object_type
  @object_type
end

#setup_states ⇒ Object

Returns the value of attribute setup_states.



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

def setup_states
  @setup_states
end

#start_time ⇒ Object

Start date of the Intersight Appliance’s initial setup.



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

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



98
99
100
 
# File 'lib/intersight_client/models/appliance_setup_info.rb', line 98

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)



93
94
95
 
# File 'lib/intersight_client/models/appliance_setup_info.rb', line 93

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'backup_version' => :'BackupVersion',
    :'build_type' => :'BuildType',
    :'capabilities' => :'Capabilities',
    :'cloud_url' => :'CloudUrl',
    :'deployment_mode' => :'DeploymentMode',
    :'end_time' => :'EndTime',
    :'latest_version' => :'LatestVersion',
    :'setup_states' => :'SetupStates',
    :'start_time' => :'StartTime',
    :'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



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

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_setup_info.rb', line 129

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



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

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'backup_version' => :'String',
    :'build_type' => :'String',
    :'capabilities' => :'Array<ApplianceKeyValuePair>',
    :'cloud_url' => :'String',
    :'deployment_mode' => :'String',
    :'end_time' => :'Time',
    :'latest_version' => :'String',
    :'setup_states' => :'Array<String>',
    :'start_time' => :'Time',
    :'account' => :'IamAccountRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      backup_version == o.backup_version &&
      build_type == o.build_type &&
      capabilities == o.capabilities &&
      cloud_url == o.cloud_url &&
      deployment_mode == o.deployment_mode &&
      end_time == o.end_time &&
      latest_version == o.latest_version &&
      setup_states == o.setup_states &&
      start_time == o.start_time &&
       == 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



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
378
379
 
# File 'lib/intersight_client/models/appliance_setup_info.rb', line 342

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



413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/intersight_client/models/appliance_setup_info.rb', line 413

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



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

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



304
305
306
 
# File 'lib/intersight_client/models/appliance_setup_info.rb', line 304

def hash
  [class_id, object_type, backup_version, build_type, capabilities, cloud_url, deployment_mode, end_time, latest_version, setup_states, start_time, ].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



220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/intersight_client/models/appliance_setup_info.rb', line 220

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



389
390
391
 
# File 'lib/intersight_client/models/appliance_setup_info.rb', line 389

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



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/intersight_client/models/appliance_setup_info.rb', line 395

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



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

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



235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/intersight_client/models/appliance_setup_info.rb', line 235

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["appliance.SetupInfo"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["appliance.SetupInfo"])
  return false unless object_type_validator.valid?(@object_type)
  deployment_mode_validator = EnumAttributeValidator.new('String', ["Connected", "Private"])
  return false unless deployment_mode_validator.valid?(@deployment_mode)
  true && super
end