Class: IntersightClient::OsBaseInstallConfigAllOf

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

Overview

Definition of the list of properties defined in ‘os.BaseInstallConfig’, excluding properties defined in parent classes.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OsBaseInstallConfigAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



121
122
123
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
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 121

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

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'os.Install'
  end

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

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

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

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

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

  if attributes.key?(:'install_method')
    self.install_method = attributes[:'install_method']
  else
    self.install_method = 'vMedia'
  end

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

  if attributes.key?(:'oper_state')
    self.oper_state = attributes[:'oper_state']
  else
    self.oper_state = 'Pending'
  end

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

Instance Attribute Details

#additional_parameters ⇒ Object

Returns the value of attribute additional_parameters.



25
26
27
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 25

def additional_parameters
  @additional_parameters
end

#answers ⇒ Object

Returns the value of attribute answers.



27
28
29
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 27

def answers
  @answers
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. The enum values provides the list of concrete types that can be instantiated from this abstract type.



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

def class_id
  @class_id
end

#description ⇒ Object

User provided description about the OS install configuration.



30
31
32
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 30

def description
  @description
end

#error_msg ⇒ Object

The failure message of the API.



33
34
35
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 33

def error_msg
  @error_msg
end

#install_method ⇒ Object

The install method to be used for OS installation - vMedia, iPXE. Only vMedia is supported as of now. * vMedia - OS image is mounted as vMedia in target server for OS installation.



36
37
38
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 36

def install_method
  @install_method
end

#install_target ⇒ Object

Returns the value of attribute install_target.



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

def install_target
  @install_target
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property. The enum values provides the list of concrete types that can be instantiated from this abstract type.



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

def object_type
  @object_type
end

#oper_state ⇒ Object

Denotes API operating status as pending, in_progress, completed_ok, completed_error based on the execution status. * Pending - The initial value of the OperStatus. * InProgress - The OperStatus value will be InProgress during execution. * CompletedOk - The API is successful with operation then OperStatus will be marked as CompletedOk. * CompletedError - The API is failed with operation then OperStatus will be marked as CompletedError. * CompletedWarning - The API is completed with some warning then OperStatus will be CompletedWarning.



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

def oper_state
  @oper_state
end

#operating_system_parameters ⇒ Object

Returns the value of attribute operating_system_parameters.



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

def operating_system_parameters
  @operating_system_parameters
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about



89
90
91
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 89

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 68

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'additional_parameters' => :'AdditionalParameters',
    :'answers' => :'Answers',
    :'description' => :'Description',
    :'error_msg' => :'ErrorMsg',
    :'install_method' => :'InstallMethod',
    :'install_target' => :'InstallTarget',
    :'oper_state' => :'OperState',
    :'operating_system_parameters' => :'OperatingSystemParameters'
  }
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



288
289
290
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 288

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'additional_parameters',
    :'answers',
    :'install_target',
    :'operating_system_parameters'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 94

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'additional_parameters' => :'Array<OsPlaceHolder>',
    :'answers' => :'OsAnswers',
    :'description' => :'String',
    :'error_msg' => :'String',
    :'install_method' => :'String',
    :'install_target' => :'OsInstallTarget',
    :'oper_state' => :'String',
    :'operating_system_parameters' => :'OsOperatingSystemParameters'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 258

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      additional_parameters == o.additional_parameters &&
      answers == o.answers &&
      description == o.description &&
      error_msg == o.error_msg &&
      install_method == o.install_method &&
      install_target == o.install_target &&
      oper_state == o.oper_state &&
      operating_system_parameters == o.operating_system_parameters
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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 318

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



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 389

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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 295

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


275
276
277
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 275

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



281
282
283
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 281

def hash
  [class_id, object_type, additional_parameters, answers, description, error_msg, install_method, install_target, oper_state, operating_system_parameters].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



187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 187

def list_invalid_properties
  invalid_properties = Array.new
  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



365
366
367
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 365

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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 371

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



359
360
361
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 359

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



202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/intersight_client/models/os_base_install_config_all_of.rb', line 202

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["os.Install"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["os.Install"])
  return false unless object_type_validator.valid?(@object_type)
  install_method_validator = EnumAttributeValidator.new('String', ["vMedia"])
  return false unless install_method_validator.valid?(@install_method)
  oper_state_validator = EnumAttributeValidator.new('String', ["Pending", "InProgress", "CompletedOk", "CompletedError", "CompletedWarning"])
  return false unless oper_state_validator.valid?(@oper_state)
  true
end