Class: IntersightClient::BootPxe

Inherits:
BootDeviceBase show all
Defined in:
lib/intersight_client/models/boot_pxe.rb

Overview

Device type used when booting from a PXE boot device.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from BootDeviceBase

#enabled, #name

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BootPxe

Initializes the object

Parameters:

  • attributes (Hash) (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
 
# File 'lib/intersight_client/models/boot_pxe.rb', line 124

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

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

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

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

  if attributes.key?(:'ip_type')
    self.ip_type = attributes[:'ip_type']
  else
    self.ip_type = 'None'
  end

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

  if attributes.key?(:'port')
    self.port = attributes[:'port']
  else
    self.port = -1
  end

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

Instance Attribute Details

#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/boot_pxe.rb', line 20

def class_id
  @class_id
end

#interface_name ⇒ Object

The name of the underlying virtual ethernet interface used by the PXE boot device.



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

def interface_name
  @interface_name
end

#interface_source ⇒ Object

Lists the supported Interface Source for PXE device. Supported values are "name" and "mac". * name - Use interface name to select virtual ethernet interface. * mac - Use MAC address to select virtual ethernet interface. * port - Use port to select virtual ethernet interface.



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

def interface_source
  @interface_source
end

#ip_type ⇒ Object

The IP Address family type to use during the PXE Boot process. * None - Default value if IpType is not specified. * IPv4 - The IPv4 address family type. * IPv6 - The IPv6 address family type.



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

def ip_type
  @ip_type
end

#mac_address ⇒ Object

The MAC Address of the underlying virtual ethernet interface used by the PXE boot device.



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

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

def object_type
  @object_type
end

#port ⇒ Object

The Port ID of the adapter on which the underlying virtual ethernet interface is present. If no port is specified, the default value is -1. Supported values are -1 to 255.



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

def port
  @port
end

#slot ⇒ Object

The slot ID of the adapter on which the underlying virtual ethernet interface is present. Supported values are ( 1 - 255, "MLOM", "L", "L1", "L2", "OCP").



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

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



85
86
87
 
# File 'lib/intersight_client/models/boot_pxe.rb', line 85

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)



80
81
82
 
# File 'lib/intersight_client/models/boot_pxe.rb', line 80

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'interface_name' => :'InterfaceName',
    :'interface_source' => :'InterfaceSource',
    :'ip_type' => :'IpType',
    :'mac_address' => :'MacAddress',
    :'port' => :'Port',
    :'slot' => :'Slot'
  }
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



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

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/boot_pxe.rb', line 110

def self.openapi_all_of
  [
  :'BootDeviceBase',
  :'BootPxeAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



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

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'interface_name' => :'String',
    :'interface_source' => :'String',
    :'ip_type' => :'String',
    :'mac_address' => :'String',
    :'port' => :'Integer',
    :'slot' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/intersight_client/models/boot_pxe.rb', line 331

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      interface_name == o.interface_name &&
      interface_source == o.interface_source &&
      ip_type == o.ip_type &&
      mac_address == o.mac_address &&
      port == o.port &&
      slot == o.slot && 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



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/intersight_client/models/boot_pxe.rb', line 390

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



461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/intersight_client/models/boot_pxe.rb', line 461

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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/intersight_client/models/boot_pxe.rb', line 366

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


346
347
348
 
# File 'lib/intersight_client/models/boot_pxe.rb', line 346

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



352
353
354
 
# File 'lib/intersight_client/models/boot_pxe.rb', line 352

def hash
  [class_id, object_type, interface_name, interface_source, ip_type, mac_address, port, slot].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



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
217
218
219
 
# File 'lib/intersight_client/models/boot_pxe.rb', line 185

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

  pattern = Regexp.new(/^[a-zA-Z0-9\-._:]*$/)
  if !@interface_name.nil? && @interface_name !~ pattern
    invalid_properties.push("invalid value for \"interface_name\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^$|^(((\d|([a-f]|[A-F])){2}:){5}(\d|([a-f]|[A-F])){2})$/)
  if !@mac_address.nil? && @mac_address !~ pattern
    invalid_properties.push("invalid value for \"mac_address\", must conform to the pattern #{pattern}.")
  end

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

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

  pattern = Regexp.new(/^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]|L|MLOM|L1|L2|OCP)$/)
  if !@slot.nil? && @slot !~ pattern
    invalid_properties.push("invalid value for \"slot\", 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



437
438
439
 
# File 'lib/intersight_client/models/boot_pxe.rb', line 437

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



443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/intersight_client/models/boot_pxe.rb', line 443

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



431
432
433
 
# File 'lib/intersight_client/models/boot_pxe.rb', line 431

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/intersight_client/models/boot_pxe.rb', line 223

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["boot.Pxe"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["boot.Pxe"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@interface_name.nil? && @interface_name !~ Regexp.new(/^[a-zA-Z0-9\-._:]*$/)
  interface_source_validator = EnumAttributeValidator.new('String', ["name", "mac", "port"])
  return false unless interface_source_validator.valid?(@interface_source)
  ip_type_validator = EnumAttributeValidator.new('String', ["None", "IPv4", "IPv6"])
  return false unless ip_type_validator.valid?(@ip_type)
  return false if !@mac_address.nil? && @mac_address !~ Regexp.new(/^$|^(((\d|([a-f]|[A-F])){2}:){5}(\d|([a-f]|[A-F])){2})$/)
  return false if !@port.nil? && @port > 255
  return false if !@port.nil? && @port < -1
  return false if !@slot.nil? && @slot !~ Regexp.new(/^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]|L|MLOM|L1|L2|OCP)$/)
  true && super
end