Class: Ionoscloud::FirewallruleProperties

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FirewallruleProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash



110
111
112
113
114
115
116
117
118
119
120
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
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 110

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

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

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

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

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

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

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

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

Instance Attribute Details

#icmp_code ⇒ Object

Defines the allowed code (from 0 to 254) if protocol ICMP is chosen. Value null allows all codes



34
35
36
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 34

def icmp_code
  @icmp_code
end

#icmp_type ⇒ Object

Defines the allowed type (from 0 to 254) if the protocol ICMP is chosen. Value null allows all types



37
38
39
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 37

def icmp_type
  @icmp_type
end

#name ⇒ Object

A name of that resource



19
20
21
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 19

def name
  @name
end

#port_range_end ⇒ Object

Defines the end range of the allowed port (from 1 to 65534) if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd null to allow all ports



43
44
45
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 43

def port_range_end
  @port_range_end
end

#port_range_start ⇒ Object

Defines the start range of the allowed port (from 1 to 65534) if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports



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

def port_range_start
  @port_range_start
end

#protocol ⇒ Object

The protocol for the rule. Property cannot be modified after creation (disallowed in update requests)



22
23
24
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 22

def protocol
  @protocol
end

#source_ip ⇒ Object

Only traffic originating from the respective IPv4 address is allowed. Value null allows all source IPs



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

def source_ip
  @source_ip
end

#source_mac ⇒ Object

Only traffic originating from the respective MAC address is allowed. Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address



25
26
27
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 25

def source_mac
  @source_mac
end

#target_ip ⇒ Object

In case the target NIC has multiple IP addresses, only traffic directed to the respective IP address of the NIC is allowed. Value null allows all target IPs



31
32
33
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 31

def target_ip
  @target_ip
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



83
84
85
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 83

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

def self.attribute_map
  {
    :'name' => :'name',
    :'protocol' => :'protocol',
    :'source_mac' => :'sourceMac',
    :'source_ip' => :'sourceIp',
    :'target_ip' => :'targetIp',
    :'icmp_code' => :'icmpCode',
    :'icmp_type' => :'icmpType',
    :'port_range_start' => :'portRangeStart',
    :'port_range_end' => :'portRangeEnd'
  }
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



368
369
370
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 368

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 88

def self.openapi_types
  {
    :'name' => :'String',
    :'protocol' => :'String',
    :'source_mac' => :'String',
    :'source_ip' => :'String',
    :'target_ip' => :'String',
    :'icmp_code' => :'Integer',
    :'icmp_type' => :'Integer',
    :'port_range_start' => :'Integer',
    :'port_range_end' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 339

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      protocol == o.protocol &&
      source_mac == o.source_mac &&
      source_ip == o.source_ip &&
      target_ip == o.target_ip &&
      icmp_code == o.icmp_code &&
      icmp_type == o.icmp_type &&
      port_range_start == o.port_range_start &&
      port_range_end == o.port_range_end
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



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
428
429
430
431
432
433
434
435
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 398

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



469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 469

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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 375

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


355
356
357
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 355

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



361
362
363
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 361

def hash
  [name, protocol, source_mac, source_ip, target_ip, icmp_code, icmp_type, port_range_start, port_range_end].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



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/ionoscloud/models/firewallrule_properties.rb', line 162

def list_invalid_properties
  invalid_properties = Array.new
  if @protocol.nil?
    invalid_properties.push('invalid value for "protocol", protocol cannot be nil.')
  end

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

  pattern = Regexp.new(/^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/)
  if !@source_ip.nil? && @source_ip !~ pattern
    invalid_properties.push("invalid value for \"source_ip\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/)
  if !@target_ip.nil? && @target_ip !~ pattern
    invalid_properties.push("invalid value for \"target_ip\", must conform to the pattern #{pattern}.")
  end

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

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

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

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

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

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

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

  if !@port_range_end.nil? && @port_range_end < 1
    invalid_properties.push('invalid value for "port_range_end", must be greater than or equal to 1.')
  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



445
446
447
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 445

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



451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 451

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



439
440
441
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 439

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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 220

def valid?
  return false if @protocol.nil?
  protocol_validator = EnumAttributeValidator.new('String', ["TCP", "UDP", "ICMP", "ANY"])
  return false unless protocol_validator.valid?(@protocol)
  return false if !@source_mac.nil? && @source_mac !~ Regexp.new(/^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/)
  return false if !@source_ip.nil? && @source_ip !~ Regexp.new(/^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/)
  return false if !@target_ip.nil? && @target_ip !~ Regexp.new(/^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/)
  return false if !@icmp_code.nil? && @icmp_code > 254
  return false if !@icmp_code.nil? && @icmp_code < 0
  return false if !@icmp_type.nil? && @icmp_type > 254
  return false if !@icmp_type.nil? && @icmp_type < 0
  return false if !@port_range_start.nil? && @port_range_start > 65534
  return false if !@port_range_start.nil? && @port_range_start < 1
  return false if !@port_range_end.nil? && @port_range_end > 65534
  return false if !@port_range_end.nil? && @port_range_end < 1
  true
end