Class: Ionoscloud::NicProperties

Inherits:
Object
  • Object
show all
Defined in:
lib/ionoscloud/models/nic_properties.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NicProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 147

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Ionoscloud::NicProperties` 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.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Ionoscloud::NicProperties`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }
  

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


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


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


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


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


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


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


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


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

Instance Attribute Details

#device_number ⇒ Object

The Logical Unit Number (LUN) of the storage volume. Null if this NIC was created using Cloud API and no DCD changes were performed on the Datacenter.



48
49
50
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 48

def device_number
  @device_number
end

#dhcp ⇒ Object

Indicates if the NIC will reserve an IP using DHCP.



32
33
34
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 32

def dhcp
  @dhcp
end

#firewall_active ⇒ Object

Activate or deactivate the firewall. By default, an active firewall without any defined rules will block all incoming network traffic except for the firewall rules that explicitly allows certain protocols, IP addresses and ports.



40
41
42
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 40

def firewall_active
  @firewall_active
end

#firewall_type ⇒ Object

The type of firewall rules that will be allowed on the NIC. If not specified, the default INGRESS value is used.



44
45
46
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 44

def firewall_type
  @firewall_type
end

#ips ⇒ Object

Collection of IP addresses, assigned to the NIC. Explicitly assigned public IPs need to come from reserved IP blocks. Passing value null or empty array will assign an IP address automatically.



28
29
30
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 28

def ips
  @ips
end

#lan ⇒ Object

The LAN ID the NIC will be on. If the LAN ID does not exist, it will be implicitly created.



36
37
38
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 36

def lan
  @lan
end

#mac ⇒ Object

The MAC address of the NIC.



24
25
26
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 24

def mac
  @mac
end

#name ⇒ Object

The name of the resource.



20
21
22
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 20

def name
  @name
end

#pci_slot ⇒ Object

The PCI slot number for the NIC.



52
53
54
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 52

def pci_slot
  @pci_slot
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



101
102
103
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 101

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 77

def self.attribute_map
  {
    
    :'name' => :'name',

    :'mac' => :'mac',

    :'ips' => :'ips',

    :'dhcp' => :'dhcp',

    :'lan' => :'lan',

    :'firewall_active' => :'firewallActive',

    :'firewall_type' => :'firewallType',

    :'device_number' => :'deviceNumber',

    :'pci_slot' => :'pciSlot'
  }
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



294
295
296
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 294

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 130

def self.openapi_nullable
  Set.new([
    


    :'ips',






  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 106

def self.openapi_types
  {
    
    :'name' => :'String',

    :'mac' => :'String',

    :'ips' => :'Array<String>',

    :'dhcp' => :'Boolean',

    :'lan' => :'Integer',

    :'firewall_active' => :'Boolean',

    :'firewall_type' => :'String',

    :'device_number' => :'Integer',

    :'pci_slot' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 265

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    name == o.name &&
    mac == o.mac &&
    ips == o.ips &&
    dhcp == o.dhcp &&
    lan == o.lan &&
    firewall_active == o.firewall_active &&
    firewall_type == o.firewall_type &&
    device_number == o.device_number &&
    pci_slot == o.pci_slot
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



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
356
357
358
359
360
361
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 324

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 = Ionoscloud.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



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

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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 301

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


281
282
283
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 281

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



287
288
289
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 287

def hash
  [name, mac, ips, dhcp, lan, firewall_active, firewall_type, device_number, pci_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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 208

def list_invalid_properties
  invalid_properties = Array.new
  




  if @lan.nil?
    invalid_properties.push('invalid value for "lan", lan 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



371
372
373
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 371

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



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 377

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



365
366
367
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 365

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/ionoscloud/models/nic_properties.rb', line 228

def valid?
  




  return false if @lan.nil?


  firewall_type_validator = EnumAttributeValidator.new('String', ["INGRESS", "EGRESS", "BIDIRECTIONAL"])
  return false unless firewall_type_validator.valid?(@firewall_type)


  true
end