Class: OCI::Waas::Models::JsChallenge
- Inherits:
-
Object
- Object
- OCI::Waas::Models::JsChallenge
- Defined in:
- lib/oci/waas/models/js_challenge.rb
Overview
The JavaScript challenge settings. JavaScript Challenge is the function to filter abnormal or malicious bots and allow access to real clients.
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
-
#action ⇒ String
The action to take against requests from detected bots.
-
#action_expiration_in_seconds ⇒ Integer
The number of seconds between challenges from the same IP address.
-
#are_redirects_challenged ⇒ BOOLEAN
When enabled, redirect responses from the origin will also be challenged.
- #challenge_settings ⇒ OCI::Waas::Models::BlockChallengeSettings
-
#criteria ⇒ Array<OCI::Waas::Models::AccessRuleCriteria>
When defined, the JavaScript Challenge would be applied only for the requests that matched all the listed conditions.
-
#failure_threshold ⇒ Integer
The number of failed requests before taking action.
-
#is_enabled ⇒ BOOLEAN
[Required] Enables or disables the JavaScript challenge Web Application Firewall feature.
-
#is_nat_enabled ⇒ BOOLEAN
When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses.
-
#set_http_header ⇒ OCI::Waas::Models::Header
Adds an additional HTTP header to requests that fail the challenge before being passed to the origin.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ JsChallenge
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ JsChallenge
Initializes the object
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/oci/waas/models/js_challenge.rb', line 102 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.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil? raise 'You cannot provide both :isEnabled and :is_enabled' if attributes.key?(:'isEnabled') && attributes.key?(:'is_enabled') self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil? self.action = attributes[:'action'] if attributes[:'action'] self.failure_threshold = attributes[:'failureThreshold'] if attributes[:'failureThreshold'] raise 'You cannot provide both :failureThreshold and :failure_threshold' if attributes.key?(:'failureThreshold') && attributes.key?(:'failure_threshold') self.failure_threshold = attributes[:'failure_threshold'] if attributes[:'failure_threshold'] self.action_expiration_in_seconds = attributes[:'actionExpirationInSeconds'] if attributes[:'actionExpirationInSeconds'] raise 'You cannot provide both :actionExpirationInSeconds and :action_expiration_in_seconds' if attributes.key?(:'actionExpirationInSeconds') && attributes.key?(:'action_expiration_in_seconds') self.action_expiration_in_seconds = attributes[:'action_expiration_in_seconds'] if attributes[:'action_expiration_in_seconds'] self.set_http_header = attributes[:'setHttpHeader'] if attributes[:'setHttpHeader'] raise 'You cannot provide both :setHttpHeader and :set_http_header' if attributes.key?(:'setHttpHeader') && attributes.key?(:'set_http_header') self.set_http_header = attributes[:'set_http_header'] if attributes[:'set_http_header'] self.challenge_settings = attributes[:'challengeSettings'] if attributes[:'challengeSettings'] raise 'You cannot provide both :challengeSettings and :challenge_settings' if attributes.key?(:'challengeSettings') && attributes.key?(:'challenge_settings') self.challenge_settings = attributes[:'challenge_settings'] if attributes[:'challenge_settings'] self.are_redirects_challenged = attributes[:'areRedirectsChallenged'] unless attributes[:'areRedirectsChallenged'].nil? self.are_redirects_challenged = true if are_redirects_challenged.nil? && !attributes.key?(:'areRedirectsChallenged') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :areRedirectsChallenged and :are_redirects_challenged' if attributes.key?(:'areRedirectsChallenged') && attributes.key?(:'are_redirects_challenged') self.are_redirects_challenged = attributes[:'are_redirects_challenged'] unless attributes[:'are_redirects_challenged'].nil? self.are_redirects_challenged = true if are_redirects_challenged.nil? && !attributes.key?(:'areRedirectsChallenged') && !attributes.key?(:'are_redirects_challenged') # rubocop:disable Style/StringLiterals self.criteria = attributes[:'criteria'] if attributes[:'criteria'] self.is_nat_enabled = attributes[:'isNatEnabled'] unless attributes[:'isNatEnabled'].nil? self.is_nat_enabled = true if is_nat_enabled.nil? && !attributes.key?(:'isNatEnabled') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isNatEnabled and :is_nat_enabled' if attributes.key?(:'isNatEnabled') && attributes.key?(:'is_nat_enabled') self.is_nat_enabled = attributes[:'is_nat_enabled'] unless attributes[:'is_nat_enabled'].nil? self.is_nat_enabled = true if is_nat_enabled.nil? && !attributes.key?(:'isNatEnabled') && !attributes.key?(:'is_nat_enabled') # rubocop:disable Style/StringLiterals end |
Instance Attribute Details
#action ⇒ String
The action to take against requests from detected bots. If unspecified, defaults to DETECT
.
24 25 26 |
# File 'lib/oci/waas/models/js_challenge.rb', line 24 def action @action end |
#action_expiration_in_seconds ⇒ Integer
The number of seconds between challenges from the same IP address. If unspecified, defaults to 60
.
32 33 34 |
# File 'lib/oci/waas/models/js_challenge.rb', line 32 def action_expiration_in_seconds @action_expiration_in_seconds end |
#are_redirects_challenged ⇒ BOOLEAN
When enabled, redirect responses from the origin will also be challenged. This will change HTTP 301/302 responses from origin to HTTP 200 with an HTML body containing JavaScript page redirection.
43 44 45 |
# File 'lib/oci/waas/models/js_challenge.rb', line 43 def are_redirects_challenged @are_redirects_challenged end |
#challenge_settings ⇒ OCI::Waas::Models::BlockChallengeSettings
39 40 41 |
# File 'lib/oci/waas/models/js_challenge.rb', line 39 def challenge_settings @challenge_settings end |
#criteria ⇒ Array<OCI::Waas::Models::AccessRuleCriteria>
When defined, the JavaScript Challenge would be applied only for the requests that matched all the listed conditions.
47 48 49 |
# File 'lib/oci/waas/models/js_challenge.rb', line 47 def criteria @criteria end |
#failure_threshold ⇒ Integer
The number of failed requests before taking action. If unspecified, defaults to 10
.
28 29 30 |
# File 'lib/oci/waas/models/js_challenge.rb', line 28 def failure_threshold @failure_threshold end |
#is_enabled ⇒ BOOLEAN
[Required] Enables or disables the JavaScript challenge Web Application Firewall feature.
20 21 22 |
# File 'lib/oci/waas/models/js_challenge.rb', line 20 def is_enabled @is_enabled end |
#is_nat_enabled ⇒ BOOLEAN
When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses.
51 52 53 |
# File 'lib/oci/waas/models/js_challenge.rb', line 51 def is_nat_enabled @is_nat_enabled end |
#set_http_header ⇒ OCI::Waas::Models::Header
Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the action
is set to DETECT
.
36 37 38 |
# File 'lib/oci/waas/models/js_challenge.rb', line 36 def set_http_header @set_http_header end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/oci/waas/models/js_challenge.rb', line 54 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'is_enabled': :'isEnabled', 'action': :'action', 'failure_threshold': :'failureThreshold', 'action_expiration_in_seconds': :'actionExpirationInSeconds', 'set_http_header': :'setHttpHeader', 'challenge_settings': :'challengeSettings', 'are_redirects_challenged': :'areRedirectsChallenged', 'criteria': :'criteria', 'is_nat_enabled': :'isNatEnabled' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/oci/waas/models/js_challenge.rb', line 71 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'is_enabled': :'BOOLEAN', 'action': :'String', 'failure_threshold': :'Integer', 'action_expiration_in_seconds': :'Integer', 'set_http_header': :'OCI::Waas::Models::Header', 'challenge_settings': :'OCI::Waas::Models::BlockChallengeSettings', 'are_redirects_challenged': :'BOOLEAN', 'criteria': :'Array<OCI::Waas::Models::AccessRuleCriteria>', 'is_nat_enabled': :'BOOLEAN' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/oci/waas/models/js_challenge.rb', line 179 def ==(other) return true if equal?(other) self.class == other.class && is_enabled == other.is_enabled && action == other.action && failure_threshold == other.failure_threshold && action_expiration_in_seconds == other.action_expiration_in_seconds && set_http_header == other.set_http_header && challenge_settings == other.challenge_settings && are_redirects_challenged == other.are_redirects_challenged && criteria == other.criteria && is_nat_enabled == other.is_nat_enabled end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/oci/waas/models/js_challenge.rb', line 217 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
197 198 199 |
# File 'lib/oci/waas/models/js_challenge.rb', line 197 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
206 207 208 |
# File 'lib/oci/waas/models/js_challenge.rb', line 206 def hash [is_enabled, action, failure_threshold, action_expiration_in_seconds, set_http_header, challenge_settings, are_redirects_challenged, criteria, is_nat_enabled].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
250 251 252 253 254 255 256 257 258 259 |
# File 'lib/oci/waas/models/js_challenge.rb', line 250 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
244 245 246 |
# File 'lib/oci/waas/models/js_challenge.rb', line 244 def to_s to_hash.to_s end |