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



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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 170

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?(:'icmp_code')
    self.icmp_code = attributes[:'icmp_code']
  end


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


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


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


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


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


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


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


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


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


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

Instance Attribute Details

#icmp_code ⇒ Object

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



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

def icmp_code
  @icmp_code
end

#icmp_type ⇒ Object

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



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

def icmp_type
  @icmp_type
end

#ip_version ⇒ Object

The IP version for this rule. If sourceIp or targetIp are specified, you can omit this value - the IP version will then be deduced from the IP address(es) used; if you specify it anyway, it must match the specified IP address(es). If neither sourceIp nor targetIp are specified, this rule allows traffic only for the specified IP version. If neither sourceIp, targetIp nor ipVersion are specified, this rule will only allow IPv4 traffic.



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

def ip_version
  @ip_version
end

#name ⇒ Object

The name of the resource.



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

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.



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

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 it is created (disallowed in update requests).



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

def protocol
  @protocol
end

#source_ip ⇒ Object

Only traffic originating from the respective IP address (or CIDR block) is allowed. Value null allows traffic from any IP address (according to the selected ipVersion).



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

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 traffic from any MAC address.



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

def source_mac
  @source_mac
end

#target_ip ⇒ Object

If the target NIC has multiple IP addresses, only the traffic directed to the respective IP address (or CIDR block) of the NIC is allowed. Value null allows traffic to any target IP address (according to the selected ipVersion).



56
57
58
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 56

def target_ip
  @target_ip
end

#type ⇒ Object

The type of the firewall rule. If not specified, the default INGRESS value is used.



60
61
62
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 60

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



113
114
115
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 113

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 85

def self.attribute_map
  {
    
    :'icmp_code' => :'icmpCode',

    :'icmp_type' => :'icmpType',

    :'ip_version' => :'ipVersion',

    :'name' => :'name',

    :'port_range_end' => :'portRangeEnd',

    :'port_range_start' => :'portRangeStart',

    :'protocol' => :'protocol',

    :'source_ip' => :'sourceIp',

    :'source_mac' => :'sourceMac',

    :'target_ip' => :'targetIp',

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



455
456
457
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 455

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 146

def self.openapi_nullable
  Set.new([
    
    :'icmp_code',

    :'icmp_type',

    :'ip_version',





    :'source_ip',

    :'source_mac',

    :'target_ip',

  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    
    :'icmp_code' => :'Integer',

    :'icmp_type' => :'Integer',

    :'ip_version' => :'String',

    :'name' => :'String',

    :'port_range_end' => :'Integer',

    :'port_range_start' => :'Integer',

    :'protocol' => :'String',

    :'source_ip' => :'String',

    :'source_mac' => :'String',

    :'target_ip' => :'String',

    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 424

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



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 485

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



556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 556

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



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 462

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


442
443
444
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 442

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



448
449
450
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 448

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 241

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


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



532
533
534
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 532

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



538
539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 538

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



526
527
528
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 526

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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/ionoscloud/models/firewallrule_properties.rb', line 295

def valid?
  
  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

  ip_version_validator = EnumAttributeValidator.new('String', ["IPv4", "IPv6"])
  return false unless ip_version_validator.valid?(@ip_version)


  return false if !@port_range_end.nil? && @port_range_end > 65534
  return false if !@port_range_end.nil? && @port_range_end < 1

  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 @protocol.nil?
  protocol_validator = EnumAttributeValidator.new('String', ["TCP", "UDP", "ICMP", "ICMPv6", "ANY"])
  return false unless protocol_validator.valid?(@protocol)




  type_validator = EnumAttributeValidator.new('String', ["INGRESS", "EGRESS"])
  return false unless type_validator.valid?(@type)
  true
end