Class: OCI::Waas::Models::ProtectionRuleAction

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

Overview

A protection rule key and the associated action to apply to that rule.

Constant Summary collapse

ACTION_ENUM =

rubocop:disable Metrics/LineLength

[
  ACTION_OFF = 'OFF'.freeze,
  ACTION_DETECT = 'DETECT'.freeze,
  ACTION_BLOCK = 'BLOCK'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProtectionRuleAction

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/waas/models/protection_rule_action.rb', line 58

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.action = attributes[:'action'] if attributes[:'action']

  self.exclusions = attributes[:'exclusions'] if attributes[:'exclusions']
end

Instance Attribute Details

#action ⇒ String

[Required] The action to apply to the protection rule. If unspecified, defaults to ‘OFF`.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/waas/models/protection_rule_action.rb', line 21

def action
  @action
end

#exclusions ⇒ Array<OCI::Waas::Models::ProtectionRuleExclusion>

The types of requests excluded from the protection rule action. If the requests matches the criteria in the ‘exclusions`, the protection rule action will not be executed.

Returns:



25
26
27
 
# File 'lib/oci/waas/models/protection_rule_action.rb', line 25

def exclusions
  @exclusions
end

#key ⇒ String

[Required] The unique key of the protection rule.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/waas/models/protection_rule_action.rb', line 17

def key
  @key
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
 
# File 'lib/oci/waas/models/protection_rule_action.rb', line 28

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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



88
89
90
91
92
93
94
95
 
# File 'lib/oci/waas/models/protection_rule_action.rb', line 88

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

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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/waas/models/protection_rule_action.rb', line 120

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


100
101
102
 
# File 'lib/oci/waas/models/protection_rule_action.rb', line 100

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



109
110
111
 
# File 'lib/oci/waas/models/protection_rule_action.rb', line 109

def hash
  [key, action, exclusions].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/waas/models/protection_rule_action.rb', line 153

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



147
148
149
 
# File 'lib/oci/waas/models/protection_rule_action.rb', line 147

def to_s
  to_hash.to_s
end