Class: OCI::Waas::Models::WaasPolicyCustomProtectionRuleSummary

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WaasPolicyCustomProtectionRuleSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 74

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

#actionString

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.

Returns:

  • (String)


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

def action
  @action
end

#display_nameString

The user-friendly name of the custom protection rule.

Returns:

  • (String)


23
24
25
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 23

def display_name
  @display_name
end

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



35
36
37
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 35

def exclusions
  @exclusions
end

#idString

The OCID of the custom protection rule.

Returns:

  • (String)


19
20
21
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 19

def id
  @id
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>)


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

def mod_security_rule_ids
  @mod_security_rule_ids
end

Class Method Details

.attribute_mapObject

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



38
39
40
41
42
43
44
45
46
47
48
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 38

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_typesObject

Attribute type mapping.



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

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.

Parameters:

  • other (Object)

    the other object to be compared



119
120
121
122
123
124
125
126
127
128
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 119

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

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 153

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


133
134
135
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 133

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



142
143
144
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 142

def hash
  [id, display_name, action, mod_security_rule_ids, exclusions].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



186
187
188
189
190
191
192
193
194
195
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 186

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



180
181
182
# File 'lib/oci/waas/models/waas_policy_custom_protection_rule_summary.rb', line 180

def to_s
  to_hash.to_s
end