Class: OCI::Waas::Models::WaasPolicyCustomProtectionRuleSummary
- Inherits:
-
Object
- Object
- OCI::Waas::Models::WaasPolicyCustomProtectionRuleSummary
- Defined in:
- lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb
Overview
The OCID and action of a custom protection rule.
Constant Summary collapse
- ACTION_ENUM =
[ 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 custom protection rule is triggered.
-
#display_name ⇒ String
The user-friendly name of the custom protection rule.
- #exclusions ⇒ Array<OCI::Waas::Models::ProtectionRuleExclusion>
-
#id ⇒ String
The OCID of the custom protection rule.
-
#mod_security_rule_ids ⇒ Array<String>
The list of the ModSecurity rule IDs that apply to this 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 = {}) ⇒ WaasPolicyCustomProtectionRuleSummary
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 = {}) ⇒ WaasPolicyCustomProtectionRuleSummary
Initializes the object
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 75 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.id = attributes[:'id'] if attributes[:'id'] self.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] self.action = attributes[:'action'] if attributes[:'action'] 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.exclusions = attributes[:'exclusions'] if attributes[:'exclusions'] end |
Instance Attribute Details
#action ⇒ String
The action to take when the custom protection rule is triggered. DETECT
- Logs the request when the criteria of the custom protection rule are met. BLOCK
- Blocks the request when the criteria of the custom protection rule are met.
29 30 31 |
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 29 def action @action end |
#display_name ⇒ String
The user-friendly name of the custom protection rule.
24 25 26 |
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 24 def display_name @display_name end |
#exclusions ⇒ Array<OCI::Waas::Models::ProtectionRuleExclusion>
36 37 38 |
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 36 def exclusions @exclusions end |
#id ⇒ String
The OCID of the custom protection rule.
20 21 22 |
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 20 def id @id 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.
33 34 35 |
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 33 def mod_security_rule_ids @mod_security_rule_ids end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
39 40 41 42 43 44 45 46 47 48 49 |
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 39 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'action': :'action', 'mod_security_rule_ids': :'modSecurityRuleIds', 'exclusions': :'exclusions' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 52 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'action': :'String', 'mod_security_rule_ids': :'Array<String>', 'exclusions': :'Array<OCI::Waas::Models::ProtectionRuleExclusion>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
120 121 122 123 124 125 126 127 128 129 |
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 120 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && action == other.action && mod_security_rule_ids == other.mod_security_rule_ids && exclusions == other.exclusions end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 154 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
134 135 136 |
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 134 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
143 144 145 |
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 143 def hash [id, display_name, action, mod_security_rule_ids, exclusions].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
187 188 189 190 191 192 193 194 195 196 |
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 187 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
181 182 183 |
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 181 def to_s to_hash.to_s end |