Class: OCI::Waas::Models::JsChallenge

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JsChallenge

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/waas/models/js_challenge.rb', line 79

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']
end

Instance Attribute Details

#action ⇒ String

The action to take against requests from detected bots. If unspecified, defaults to ‘DETECT`.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/waas/models/js_challenge.rb', line 22

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`.

Returns:

  • (Integer) 


30
31
32
 
# File 'lib/oci/waas/models/js_challenge.rb', line 30

def action_expiration_in_seconds
  @action_expiration_in_seconds
end

#challenge_settings ⇒ OCI::Waas::Models::BlockChallengeSettings

Returns:



37
38
39
 
# File 'lib/oci/waas/models/js_challenge.rb', line 37

def challenge_settings
  @challenge_settings
end

#failure_threshold ⇒ Integer

The number of failed requests before taking action. If unspecified, defaults to ‘10`.

Returns:

  • (Integer) 


26
27
28
 
# File 'lib/oci/waas/models/js_challenge.rb', line 26

def failure_threshold
  @failure_threshold
end

#is_enabled ⇒ BOOLEAN

[Required] Enables or disables the JavaScript challenge Web Application Firewall feature.

Returns:

  • (BOOLEAN) 


18
19
20
 
# File 'lib/oci/waas/models/js_challenge.rb', line 18

def is_enabled
  @is_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`.

Returns:



34
35
36
 
# File 'lib/oci/waas/models/js_challenge.rb', line 34

def set_http_header
  @set_http_header
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/waas/models/js_challenge.rb', line 40

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/waas/models/js_challenge.rb', line 54

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'
    # 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



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

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
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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/waas/models/js_challenge.rb', line 173

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


153
154
155
 
# File 'lib/oci/waas/models/js_challenge.rb', line 153

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



162
163
164
 
# File 'lib/oci/waas/models/js_challenge.rb', line 162

def hash
  [is_enabled, action, failure_threshold, action_expiration_in_seconds, set_http_header, challenge_settings].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/waas/models/js_challenge.rb', line 206

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



200
201
202
 
# File 'lib/oci/waas/models/js_challenge.rb', line 200

def to_s
  to_hash.to_s
end