Class: OCI::Waf::Models::RequestProtection

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/waf/models/request_protection.rb

Overview

Module that allows to enable OCI-managed protection capabilities for incoming HTTP requests.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestProtection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/waf/models/request_protection.rb', line 67

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

  self.body_inspection_size_limit_in_bytes = attributes[:'bodyInspectionSizeLimitInBytes'] if attributes[:'bodyInspectionSizeLimitInBytes']

  raise 'You cannot provide both :bodyInspectionSizeLimitInBytes and :body_inspection_size_limit_in_bytes' if attributes.key?(:'bodyInspectionSizeLimitInBytes') && attributes.key?(:'body_inspection_size_limit_in_bytes')

  self.body_inspection_size_limit_in_bytes = attributes[:'body_inspection_size_limit_in_bytes'] if attributes[:'body_inspection_size_limit_in_bytes']

  self.body_inspection_size_limit_exceeded_action_name = attributes[:'bodyInspectionSizeLimitExceededActionName'] if attributes[:'bodyInspectionSizeLimitExceededActionName']

  raise 'You cannot provide both :bodyInspectionSizeLimitExceededActionName and :body_inspection_size_limit_exceeded_action_name' if attributes.key?(:'bodyInspectionSizeLimitExceededActionName') && attributes.key?(:'body_inspection_size_limit_exceeded_action_name')

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

Instance Attribute Details

#body_inspection_size_limit_exceeded_action_name ⇒ String

References action by name from actions defined in WebAppFirewallPolicy. Executed if HTTP message body size exceeds limit set in field bodyInspectionSizeLimitInBytes.

If this field is null HTTP message body will inspected up to bodyInspectionSizeLimitInBytes and the rest will not be inspected by Protection Capabilities.

Allowed action types: * RETURN_HTTP_RESPONSE terminates further execution of modules and rules and returns defined HTTP response.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/waf/models/request_protection.rb', line 34

def body_inspection_size_limit_exceeded_action_name
  @body_inspection_size_limit_exceeded_action_name
end

#body_inspection_size_limit_in_bytes ⇒ Integer

Maximum size of inspected HTTP message body in bytes. Actions to take if this limit is exceeded are defined in bodyInspectionSizeLimitExceededActionName.

Body inspection maximum size allowed is defined with per-tenancy limit: 8192 bytes.

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/oci/waf/models/request_protection.rb', line 22

def body_inspection_size_limit_in_bytes
  @body_inspection_size_limit_in_bytes
end

#rules ⇒ Array<OCI::Waf::Models::ProtectionRule>

Ordered list of ProtectionRules. Rules are executed in order of appearance in this array. ProtectionRules in this array can only use protection Capabilities of REQUEST_PROTECTION_CAPABILITY type.

Returns:



15
16
17
 
# File 'lib/oci/waf/models/request_protection.rb', line 15

def rules
  @rules
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/waf/models/request_protection.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'rules': :'rules',
    'body_inspection_size_limit_in_bytes': :'bodyInspectionSizeLimitInBytes',
    'body_inspection_size_limit_exceeded_action_name': :'bodyInspectionSizeLimitExceededActionName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/waf/models/request_protection.rb', line 48

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'rules': :'Array<OCI::Waf::Models::ProtectionRule>',
    'body_inspection_size_limit_in_bytes': :'Integer',
    'body_inspection_size_limit_exceeded_action_name': :'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



95
96
97
98
99
100
101
102
 
# File 'lib/oci/waf/models/request_protection.rb', line 95

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

  self.class == other.class &&
    rules == other.rules &&
    body_inspection_size_limit_in_bytes == other.body_inspection_size_limit_in_bytes &&
    body_inspection_size_limit_exceeded_action_name == other.body_inspection_size_limit_exceeded_action_name
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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/waf/models/request_protection.rb', line 127

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


107
108
109
 
# File 'lib/oci/waf/models/request_protection.rb', line 107

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



116
117
118
 
# File 'lib/oci/waf/models/request_protection.rb', line 116

def hash
  [rules, body_inspection_size_limit_in_bytes, body_inspection_size_limit_exceeded_action_name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/waf/models/request_protection.rb', line 160

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



154
155
156
 
# File 'lib/oci/waf/models/request_protection.rb', line 154

def to_s
  to_hash.to_s
end