Class: OCI::Waas::Models::HumanInteractionChallenge

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

Overview

The human interaction challenge settings. The human interaction challenge checks various event listeners in the user's browser to determine if there is a human user making a request.

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 = {}) ⇒ HumanInteractionChallenge

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 109

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

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

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

  self.interaction_threshold = attributes[:'interactionThreshold'] if attributes[:'interactionThreshold']

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

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

  self.recording_period_in_seconds = attributes[:'recordingPeriodInSeconds'] if attributes[:'recordingPeriodInSeconds']

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

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

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 24

def action
  @action
end

#action_expiration_in_seconds ⇒ Integer

The number of seconds between challenges for the same IP address. If unspecified, defaults to 60.

Returns:

  • (Integer) 


32
33
34
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 32

def action_expiration_in_seconds
  @action_expiration_in_seconds
end

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

Returns:



51
52
53
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 51

def challenge_settings
  @challenge_settings
end

#failure_threshold ⇒ Integer

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

Returns:

  • (Integer) 


28
29
30
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 28

def failure_threshold
  @failure_threshold
end

#failure_threshold_expiration_in_seconds ⇒ Integer

The number of seconds before the failure threshold resets. If unspecified, defaults to 60.

Returns:

  • (Integer) 


36
37
38
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 36

def failure_threshold_expiration_in_seconds
  @failure_threshold_expiration_in_seconds
end

#interaction_threshold ⇒ Integer

The number of interactions required to pass the challenge. If unspecified, defaults to 3.

Returns:

  • (Integer) 


40
41
42
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 40

def interaction_threshold
  @interaction_threshold
end

#is_enabled ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


20
21
22
 
# File 'lib/oci/waas/models/human_interaction_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.

Returns:

  • (BOOLEAN) 


55
56
57
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 55

def is_nat_enabled
  @is_nat_enabled
end

#recording_period_in_seconds ⇒ Integer

The number of seconds to record the interactions from the user. If unspecified, defaults to 15.

Returns:

  • (Integer) 


44
45
46
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 44

def recording_period_in_seconds
  @recording_period_in_seconds
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:



48
49
50
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 48

def set_http_header
  @set_http_header
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_enabled': :'isEnabled',
    'action': :'action',
    'failure_threshold': :'failureThreshold',
    'action_expiration_in_seconds': :'actionExpirationInSeconds',
    'failure_threshold_expiration_in_seconds': :'failureThresholdExpirationInSeconds',
    'interaction_threshold': :'interactionThreshold',
    'recording_period_in_seconds': :'recordingPeriodInSeconds',
    'set_http_header': :'setHttpHeader',
    'challenge_settings': :'challengeSettings',
    'is_nat_enabled': :'isNatEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 76

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_enabled': :'BOOLEAN',
    'action': :'String',
    'failure_threshold': :'Integer',
    'action_expiration_in_seconds': :'Integer',
    'failure_threshold_expiration_in_seconds': :'Integer',
    'interaction_threshold': :'Integer',
    'recording_period_in_seconds': :'Integer',
    'set_http_header': :'OCI::Waas::Models::Header',
    'challenge_settings': :'OCI::Waas::Models::BlockChallengeSettings',
    'is_nat_enabled': :'BOOLEAN'
    # 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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 194

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 &&
    failure_threshold_expiration_in_seconds == other.failure_threshold_expiration_in_seconds &&
    interaction_threshold == other.interaction_threshold &&
    recording_period_in_seconds == other.recording_period_in_seconds &&
    set_http_header == other.set_http_header &&
    challenge_settings == other.challenge_settings &&
    is_nat_enabled == other.is_nat_enabled
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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 233

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


213
214
215
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 213

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



222
223
224
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 222

def hash
  [is_enabled, action, failure_threshold, action_expiration_in_seconds, failure_threshold_expiration_in_seconds, interaction_threshold, recording_period_in_seconds, set_http_header, challenge_settings, is_nat_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



266
267
268
269
270
271
272
273
274
275
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 266

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



260
261
262
 
# File 'lib/oci/waas/models/human_interaction_challenge.rb', line 260

def to_s
  to_hash.to_s
end