class Ionoscloud::FirewallruleProperties
Attributes
Defines the allowed code (from 0 to 254) if protocol ICMP is chosen. Value null allows all codes
Defines the allowed type (from 0 to 254) if the protocol ICMP is chosen. Value null allows all types
A name of that resource
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
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
The protocol for the rule. Property cannot be modified after creation (disallowed in update requests)
Only traffic originating from the respective IPv4 address is allowed. Value null allows all source IPs
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
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
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/ionoscloud/models/firewallrule_properties.rb, line 83 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/ionoscloud/models/firewallrule_properties.rb, line 368 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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
List of attributes with nullable: true
# File lib/ionoscloud/models/firewallrule_properties.rb, line 103 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
@see the `==` method @param [Object] Object
to be compared
# File lib/ionoscloud/models/firewallrule_properties.rb, line 355 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# 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
Custom attribute writer method with validation @param [Object] icmp_code
Value to be assigned
# File lib/ionoscloud/models/firewallrule_properties.rb, line 283 def icmp_code=(icmp_code) if !icmp_code.nil? && icmp_code > 254 fail ArgumentError, 'invalid value for "icmp_code", must be smaller than or equal to 254.' end if !icmp_code.nil? && icmp_code < 0 fail ArgumentError, 'invalid value for "icmp_code", must be greater than or equal to 0.' end @icmp_code = icmp_code end
Custom attribute writer method with validation @param [Object] icmp_type
Value to be assigned
# File lib/ionoscloud/models/firewallrule_properties.rb, line 297 def icmp_type=(icmp_type) if !icmp_type.nil? && icmp_type > 254 fail ArgumentError, 'invalid value for "icmp_type", must be smaller than or equal to 254.' end if !icmp_type.nil? && icmp_type < 0 fail ArgumentError, 'invalid value for "icmp_type", must be greater than or equal to 0.' end @icmp_type = icmp_type end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# 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
Custom attribute writer method with validation @param [Object] port_range_end
Value to be assigned
# File lib/ionoscloud/models/firewallrule_properties.rb, line 325 def port_range_end=(port_range_end) if !port_range_end.nil? && port_range_end > 65534 fail ArgumentError, 'invalid value for "port_range_end", must be smaller than or equal to 65534.' end if !port_range_end.nil? && port_range_end < 1 fail ArgumentError, 'invalid value for "port_range_end", must be greater than or equal to 1.' end @port_range_end = port_range_end end
Custom attribute writer method with validation @param [Object] port_range_start
Value to be assigned
# File lib/ionoscloud/models/firewallrule_properties.rb, line 311 def port_range_start=(port_range_start) if !port_range_start.nil? && port_range_start > 65534 fail ArgumentError, 'invalid value for "port_range_start", must be smaller than or equal to 65534.' end if !port_range_start.nil? && port_range_start < 1 fail ArgumentError, 'invalid value for "port_range_start", must be greater than or equal to 1.' end @port_range_start = port_range_start end
Custom attribute writer method checking allowed values (enum). @param [Object] protocol Object
to be assigned
# File lib/ionoscloud/models/firewallrule_properties.rb, line 240 def protocol=(protocol) validator = EnumAttributeValidator.new('String', ["TCP", "UDP", "ICMP", "ANY"]) unless validator.valid?(protocol) fail ArgumentError, "invalid value for \"protocol\", must be one of #{validator.allowable_values}." end @protocol = protocol end
Custom attribute writer method with validation @param [Object] source_ip
Value to be assigned
# File lib/ionoscloud/models/firewallrule_properties.rb, line 261 def source_ip=(source_ip) 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 fail ArgumentError, "invalid value for \"source_ip\", must conform to the pattern #{pattern}." end @source_ip = source_ip end
Custom attribute writer method with validation @param [Object] source_mac
Value to be assigned
# File lib/ionoscloud/models/firewallrule_properties.rb, line 250 def source_mac=(source_mac) pattern = Regexp.new(/^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/) if !source_mac.nil? && source_mac !~ pattern fail ArgumentError, "invalid value for \"source_mac\", must conform to the pattern #{pattern}." end @source_mac = source_mac end
Custom attribute writer method with validation @param [Object] target_ip
Value to be assigned
# File lib/ionoscloud/models/firewallrule_properties.rb, line 272 def target_ip=(target_ip) 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 fail ArgumentError, "invalid value for \"target_ip\", must conform to the pattern #{pattern}." end @target_ip = target_ip end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/ionoscloud/models/firewallrule_properties.rb, line 439 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# 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