Class: OCI::Waas::Models::ProtectionRuleExclusion

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/waas/models/protection_rule_exclusion.rb

Overview

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.

Constant Summary collapse

TARGET_ENUM = 
[
  TARGET_REQUEST_COOKIES = 'REQUEST_COOKIES'.freeze,
  TARGET_REQUEST_COOKIE_NAMES = 'REQUEST_COOKIE_NAMES'.freeze,
  TARGET_ARGS = 'ARGS'.freeze,
  TARGET_ARGS_NAMES = 'ARGS_NAMES'.freeze,
  TARGET_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProtectionRuleExclusion

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :target (String) —

    The value to assign to the #target property

  • :exclusions (Array<String>) —

    The value to assign to the #exclusions property

[View source]

70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/waas/models/protection_rule_exclusion.rb', line 70

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

Instance Attribute Details

#exclusions ⇒ Array<String>

Returns:

  • (Array<String>) 

40
41
42
 
# File 'lib/oci/waas/models/protection_rule_exclusion.rb', line 40

def exclusions
  @exclusions
end

#target ⇒ String

The target of the exclusion.

Returns:

  • (String) 

37
38
39
 
# File 'lib/oci/waas/models/protection_rule_exclusion.rb', line 37

def target
  @target
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

43
44
45
46
47
48
49
50
 
# File 'lib/oci/waas/models/protection_rule_exclusion.rb', line 43

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'target': :'target',
    'exclusions': :'exclusions'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

53
54
55
56
57
58
59
60
 
# File 'lib/oci/waas/models/protection_rule_exclusion.rb', line 53

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'target': :'String',
    'exclusions': :'Array<String>'
    # 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

[View source]

101
102
103
104
105
106
107
 
# File 'lib/oci/waas/models/protection_rule_exclusion.rb', line 101

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    target == other.target &&
    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

[View source]

132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/waas/models/protection_rule_exclusion.rb', line 132

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
[View source]

112
113
114
 
# File 'lib/oci/waas/models/protection_rule_exclusion.rb', line 112

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

121
122
123
 
# File 'lib/oci/waas/models/protection_rule_exclusion.rb', line 121

def hash
  [target, exclusions].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/waas/models/protection_rule_exclusion.rb', line 165

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

Returns:

  • (String) —

    String presentation of the object

[View source]

159
160
161
 
# File 'lib/oci/waas/models/protection_rule_exclusion.rb', line 159

def to_s
  to_hash.to_s
end