Class: IntersightClient::OsConfigurationFile

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

Overview

A ConfigurationFile is an OS specific answer file that helps with the unattended installation. The file can also be a template file with placeholders instead of actual answers. Intersight supports the golang template syntax specified in golang.org/pkg/text/template/. The template supports placeholders for all the properties of os.Answers MO type as well as any additional user-defined properties. The values for these placeholders shall be given during OS installation in the form of os.Answers type and ‘additionalProperties’ in os.OsInstall object.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/intersight_client/models/os_configuration_file.rb', line 134

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

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

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

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

  if attributes.key?(:'internal')
    self.internal = attributes[:'internal']
  else
    self.internal = false
  end

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

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

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

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

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

Instance Attribute Details

#catalog ⇒ Object

Returns the value of attribute catalog.



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

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

def class_id
  @class_id
end

#description ⇒ Object

Description of the OS ConfigurationFile.



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

def description
  @description
end

#distributions ⇒ Object

An array of relationships to hclOperatingSystem resources.



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

def distributions
  @distributions
end

#file_content ⇒ Object

The content of the entire configuration file is stored as value. The content can either be a static file content or a template content. The template is expected to conform to the golang template syntax. The values from os.Answers properties will be used to populate this template.



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

def file_content
  @file_content
end

#internal ⇒ Object

The internal flag is set to true when configuration file is uploaded from OS Install wizard. Internal Configuration files will not be displayed in Answer Management Page.



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

def internal
  @internal
end

#name ⇒ Object

The name of the OS ConfigurationFile that uniquely identifies the configuration file.



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

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/os_configuration_file.rb', line 23

def object_type
  @object_type
end

#placeholders ⇒ Object

Returns the value of attribute placeholders.



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

def placeholders
  @placeholders
end

#supported ⇒ Object

An internal property that is used to distinguish between the pre-canned OS configuration file entries and user provided entries.



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

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



91
92
93
 
# File 'lib/intersight_client/models/os_configuration_file.rb', line 91

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)



86
87
88
 
# File 'lib/intersight_client/models/os_configuration_file.rb', line 86

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.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/intersight_client/models/os_configuration_file.rb', line 70

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'description' => :'Description',
    :'file_content' => :'FileContent',
    :'internal' => :'Internal',
    :'name' => :'Name',
    :'placeholders' => :'Placeholders',
    :'supported' => :'Supported',
    :'catalog' => :'Catalog',
    :'distributions' => :'Distributions'
  }
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



306
307
308
 
# File 'lib/intersight_client/models/os_configuration_file.rb', line 306

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



128
129
130
 
# File 'lib/intersight_client/models/os_configuration_file.rb', line 128

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/intersight_client/models/os_configuration_file.rb', line 96

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'description' => :'String',
    :'file_content' => :'String',
    :'internal' => :'Boolean',
    :'name' => :'String',
    :'placeholders' => :'Array<OsPlaceHolder>',
    :'supported' => :'Boolean',
    :'catalog' => :'OsCatalogRelationship',
    :'distributions' => :'Array<HclOperatingSystemRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      description == o.description &&
      file_content == o.file_content &&
      internal == o.internal &&
      name == o.name &&
      placeholders == o.placeholders &&
      supported == o.supported &&
      catalog == o.catalog &&
      distributions == o.distributions && 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



337
338
339
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
 
# File 'lib/intersight_client/models/os_configuration_file.rb', line 337

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



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

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



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

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


293
294
295
 
# File 'lib/intersight_client/models/os_configuration_file.rb', line 293

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



299
300
301
 
# File 'lib/intersight_client/models/os_configuration_file.rb', line 299

def hash
  [class_id, object_type, description, file_content, internal, name, placeholders, supported, catalog, distributions].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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/intersight_client/models/os_configuration_file.rb', line 203

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 !@name.nil? && @name.to_s.length > 64
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 64.')
  end

  pattern = Regexp.new(/^[a-zA-Z0-9\._\-]+$/)
  if !@name.nil? && @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  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



384
385
386
 
# File 'lib/intersight_client/models/os_configuration_file.rb', line 384

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



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

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



378
379
380
 
# File 'lib/intersight_client/models/os_configuration_file.rb', line 378

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



227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/intersight_client/models/os_configuration_file.rb', line 227

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["os.ConfigurationFile"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["os.ConfigurationFile"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@name.nil? && @name.to_s.length > 64
  return false if !@name.nil? && @name !~ Regexp.new(/^[a-zA-Z0-9\._\-]+$/)
  true && super
end