Class: OCI::Waas::Models::ProtectionRule
- Inherits:
-
Object
- Object
- OCI::Waas::Models::ProtectionRule
- Defined in:
- lib/oci/waas/models/protection_rule.rb
Overview
The protection rule settings. Protection rules can allow, block, or trigger an alert if a request meets the parameters of an applied rule.
Constant Summary collapse
- ACTION_ENUM =
[ ACTION_OFF = 'OFF'.freeze, ACTION_DETECT = 'DETECT'.freeze, ACTION_BLOCK = 'BLOCK'.freeze, ACTION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#action ⇒ String
The action to take when the traffic is detected as malicious.
-
#description ⇒ String
The description of the protection rule.
- #exclusions ⇒ Array<OCI::Waas::Models::ProtectionRuleExclusion>
-
#key ⇒ String
The unique key of the protection rule.
-
#labels ⇒ Array<String>
The list of labels for the protection rule.
-
#mod_security_rule_ids ⇒ Array<String>
The list of the ModSecurity rule IDs that apply to this protection rule.
-
#name ⇒ String
The name of the protection rule.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ ProtectionRule
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ ProtectionRule
Initializes the object
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/oci/waas/models/protection_rule.rb', line 91 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.key = attributes[:'key'] if attributes[:'key'] self.mod_security_rule_ids = attributes[:'modSecurityRuleIds'] if attributes[:'modSecurityRuleIds'] raise 'You cannot provide both :modSecurityRuleIds and :mod_security_rule_ids' if attributes.key?(:'modSecurityRuleIds') && attributes.key?(:'mod_security_rule_ids') self.mod_security_rule_ids = attributes[:'mod_security_rule_ids'] if attributes[:'mod_security_rule_ids'] self.name = attributes[:'name'] if attributes[:'name'] self.description = attributes[:'description'] if attributes[:'description'] self.action = attributes[:'action'] if attributes[:'action'] self.labels = attributes[:'labels'] if attributes[:'labels'] self.exclusions = attributes[:'exclusions'] if attributes[:'exclusions'] end |
Instance Attribute Details
#action ⇒ String
The action to take when the traffic is detected as malicious. If unspecified, defaults to OFF
.
37 38 39 |
# File 'lib/oci/waas/models/protection_rule.rb', line 37 def action @action end |
#description ⇒ String
The description of the protection rule.
33 34 35 |
# File 'lib/oci/waas/models/protection_rule.rb', line 33 def description @description end |
#exclusions ⇒ Array<OCI::Waas::Models::ProtectionRuleExclusion>
46 47 48 |
# File 'lib/oci/waas/models/protection_rule.rb', line 46 def exclusions @exclusions end |
#key ⇒ String
The unique key of the protection rule.
21 22 23 |
# File 'lib/oci/waas/models/protection_rule.rb', line 21 def key @key end |
#labels ⇒ Array<String>
The list of labels for the protection rule.
Note: Protection rules with a ResponseBody
label will have no effect unless isResponseInspected
is true.
43 44 45 |
# File 'lib/oci/waas/models/protection_rule.rb', line 43 def labels @labels end |
#mod_security_rule_ids ⇒ Array<String>
The list of the ModSecurity rule IDs that apply to this protection rule. For more information about ModSecurity's open source WAF rules, see Mod Security’s documentation.
25 26 27 |
# File 'lib/oci/waas/models/protection_rule.rb', line 25 def mod_security_rule_ids @mod_security_rule_ids end |
#name ⇒ String
The name of the protection rule.
29 30 31 |
# File 'lib/oci/waas/models/protection_rule.rb', line 29 def name @name end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/oci/waas/models/protection_rule.rb', line 49 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'key': :'key', 'mod_security_rule_ids': :'modSecurityRuleIds', 'name': :'name', 'description': :'description', 'action': :'action', 'labels': :'labels', 'exclusions': :'exclusions' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/oci/waas/models/protection_rule.rb', line 64 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'key': :'String', 'mod_security_rule_ids': :'Array<String>', 'name': :'String', 'description': :'String', 'action': :'String', 'labels': :'Array<String>', 'exclusions': :'Array<OCI::Waas::Models::ProtectionRuleExclusion>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/oci/waas/models/protection_rule.rb', line 136 def ==(other) return true if equal?(other) self.class == other.class && key == other.key && mod_security_rule_ids == other.mod_security_rule_ids && name == other.name && description == other.description && action == other.action && labels == other.labels && exclusions == other.exclusions end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/oci/waas/models/protection_rule.rb', line 172 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 |
#eql?(other) ⇒ Boolean
152 153 154 |
# File 'lib/oci/waas/models/protection_rule.rb', line 152 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
161 162 163 |
# File 'lib/oci/waas/models/protection_rule.rb', line 161 def hash [key, mod_security_rule_ids, name, description, action, labels, exclusions].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
205 206 207 208 209 210 211 212 213 214 |
# File 'lib/oci/waas/models/protection_rule.rb', line 205 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 |
#to_s ⇒ String
Returns the string representation of the object
199 200 201 |
# File 'lib/oci/waas/models/protection_rule.rb', line 199 def to_s to_hash.to_s end |