Class: OCI::Waas::Models::ProtectionRule

Inherits:
Object
  • Object
show all
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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProtectionRule

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String)

    The value to assign to the #key property

  • :mod_security_rule_ids (Array<String>)

    The value to assign to the #mod_security_rule_ids property

  • :name (String)

    The value to assign to the #name property

  • :description (String)

    The value to assign to the #description property

  • :action (String)

    The value to assign to the #action property

  • :labels (Array<String>)

    The value to assign to the #labels property

  • :exclusions (Array<OCI::Waas::Models::ProtectionRuleExclusion>)

    The value to assign to the #exclusions property



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# File 'lib/oci/waas/models/protection_rule.rb', line 90

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

#actionString

The action to take when the traffic is detected as malicious. If unspecified, defaults to OFF.

Returns:

  • (String)


36
37
38
# File 'lib/oci/waas/models/protection_rule.rb', line 36

def action
  @action
end

#descriptionString

The description of the protection rule.

Returns:

  • (String)


32
33
34
# File 'lib/oci/waas/models/protection_rule.rb', line 32

def description
  @description
end

#exclusionsArray<OCI::Waas::Models::ProtectionRuleExclusion>



45
46
47
# File 'lib/oci/waas/models/protection_rule.rb', line 45

def exclusions
  @exclusions
end

#keyString

The unique key of the protection rule.

Returns:

  • (String)


20
21
22
# File 'lib/oci/waas/models/protection_rule.rb', line 20

def key
  @key
end

#labelsArray<String>

The list of labels for the protection rule.

Note: Protection rules with a ResponseBody label will have no effect unless isResponseInspected is true.

Returns:

  • (Array<String>)


42
43
44
# File 'lib/oci/waas/models/protection_rule.rb', line 42

def labels
  @labels
end

#mod_security_rule_idsArray<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.

Returns:

  • (Array<String>)


24
25
26
# File 'lib/oci/waas/models/protection_rule.rb', line 24

def mod_security_rule_ids
  @mod_security_rule_ids
end

#nameString

The name of the protection rule.

Returns:

  • (String)


28
29
30
# File 'lib/oci/waas/models/protection_rule.rb', line 28

def name
  @name
end

Class Method Details

.attribute_mapObject

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



48
49
50
51
52
53
54
55
56
57
58
59
60
# File 'lib/oci/waas/models/protection_rule.rb', line 48

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_typesObject

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/oci/waas/models/protection_rule.rb', line 63

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.

Parameters:

  • other (Object)

    the other object to be compared



135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/oci/waas/models/protection_rule.rb', line 135

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

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# File 'lib/oci/waas/models/protection_rule.rb', line 171

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

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


151
152
153
# File 'lib/oci/waas/models/protection_rule.rb', line 151

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



160
161
162
# File 'lib/oci/waas/models/protection_rule.rb', line 160

def hash
  [key, mod_security_rule_ids, name, description, action, labels, exclusions].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



204
205
206
207
208
209
210
211
212
213
# File 'lib/oci/waas/models/protection_rule.rb', line 204

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



198
199
200
# File 'lib/oci/waas/models/protection_rule.rb', line 198

def to_s
  to_hash.to_s
end