Class: OCI::Waf::Models::ProtectionCapabilityExclusions

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

Overview

Identifies specific HTTP message parameters to exclude from inspection by a protection capability.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProtectionCapabilityExclusions

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :request_cookies (Array<String>) —

    The value to assign to the #request_cookies property

  • :args (Array<String>) —

    The value to assign to the #args property



52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/waf/models/protection_capability_exclusions.rb', line 52

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

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

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

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

Instance Attribute Details

#args ⇒ Array<String>

List of URL query parameter values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from inspecting. Example: If we have query parameter 'argumentName=argumentValue' and args=, both 'argumentName' and 'argumentValue' will not be inspected.

Returns:

  • (Array<String>) 


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

def args
  @args
end

#request_cookies ⇒ Array<String>

List of HTTP request cookie values (by cookie name) to exclude from inspecting. Example: If we have cookie 'cookieName=cookieValue' and requestCookies=, both 'cookieName' and 'cookieValue' will not be inspected.

Returns:

  • (Array<String>) 


16
17
18
 
# File 'lib/oci/waf/models/protection_capability_exclusions.rb', line 16

def request_cookies
  @request_cookies
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
 
# File 'lib/oci/waf/models/protection_capability_exclusions.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'request_cookies': :'requestCookies',
    'args': :'args'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
42
 
# File 'lib/oci/waf/models/protection_capability_exclusions.rb', line 35

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



74
75
76
77
78
79
80
 
# File 'lib/oci/waf/models/protection_capability_exclusions.rb', line 74

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

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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/waf/models/protection_capability_exclusions.rb', line 105

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


85
86
87
 
# File 'lib/oci/waf/models/protection_capability_exclusions.rb', line 85

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



94
95
96
 
# File 'lib/oci/waf/models/protection_capability_exclusions.rb', line 94

def hash
  [request_cookies, args].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/waf/models/protection_capability_exclusions.rb', line 138

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



132
133
134
 
# File 'lib/oci/waf/models/protection_capability_exclusions.rb', line 132

def to_s
  to_hash.to_s
end