class OCI::Waas::Models::ProtectionRuleExclusion
Allows specified types of requests to bypass the protection rule. If a request matches any of the criteria in the `exclusions` field, the protection rule will not be executed. Rules can have more than one exclusion and exclusions are applied to requests disjunctively, meaning the specified exclusion strings are independently matched against the specified targets of a request. The first target to match a specified string will trigger an exclusion. Example: If the following exclusions are defined for a protection rule:
\"action\": \"BLOCK\", \"exclusions\": [ { \"target\":\"REQUEST_COOKIES\", \"exclusions\":[\"example.com\", \"12345\", \"219ffwef9w0f\"] }, { \"target\":\"REQUEST_COOKIE_NAMES\", \"exclusions\":[\"OAMAuthnCookie\", \"JSESSIONID\", \"HCM-PSJSESSIONID\"] } ], \"key\": \"1000000\",
A request with the cookie name `sessionid` would trigger an exclusion. A request with the cookie name `yourcompany.com` would not trigger and exclusion.
Constants
- TARGET_ENUM
Attributes
@return [Array<String>]
The target of the exclusion. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/waas/models/protection_rule_exclusion.rb, line 42 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'target': :'target', 'exclusions': :'exclusions' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :target The value to assign to the {#target} property @option attributes [Array<String>] :exclusions The value to assign to the {#exclusions} property
# File lib/oci/waas/models/protection_rule_exclusion.rb, line 69 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.target = attributes[:'target'] if attributes[:'target'] self.exclusions = attributes[:'exclusions'] if attributes[:'exclusions'] end
Attribute type mapping.
# File lib/oci/waas/models/protection_rule_exclusion.rb, line 52 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'target': :'String', 'exclusions': :'Array<String>' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/waas/models/protection_rule_exclusion.rb, line 100 def ==(other) return true if equal?(other) self.class == other.class && target == other.target && exclusions == other.exclusions end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/waas/models/protection_rule_exclusion.rb, line 131 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/waas/models/protection_rule_exclusion.rb, line 111 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/waas/models/protection_rule_exclusion.rb, line 120 def hash [target, exclusions].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] target Object
to be assigned
# File lib/oci/waas/models/protection_rule_exclusion.rb, line 84 def target=(target) # rubocop:disable Style/ConditionalAssignment if target && !TARGET_ENUM.include?(target) OCI.logger.debug("Unknown value for 'target' [" + target + "]. Mapping to 'TARGET_UNKNOWN_ENUM_VALUE'") if OCI.logger @target = TARGET_UNKNOWN_ENUM_VALUE else @target = target end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/waas/models/protection_rule_exclusion.rb, line 164 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/waas/models/protection_rule_exclusion.rb, line 158 def to_s to_hash.to_s end
Private Instance Methods
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/oci/waas/models/protection_rule_exclusion.rb, line 181 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