class OCI::Waas::Models::HumanInteractionChallenge

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.

Constants

ACTION_ENUM

Attributes

action[R]

The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. @return [String]

action_expiration_in_seconds[RW]

The number of seconds between challenges for the same IP address. If unspecified, defaults to `60`. @return [Integer]

challenge_settings[RW]

@return [OCI::Waas::Models::BlockChallengeSettings]

failure_threshold[RW]

The number of failed requests before taking action. If unspecified, defaults to `10`. @return [Integer]

failure_threshold_expiration_in_seconds[RW]

The number of seconds before the failure threshold resets. If unspecified, defaults to `60`. @return [Integer]

interaction_threshold[RW]

The number of interactions required to pass the challenge. If unspecified, defaults to `3`. @return [Integer]

is_enabled[RW]

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

is_nat_enabled[RW]

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. @return [BOOLEAN]

recording_period_in_seconds[RW]

The number of seconds to record the interactions from the user. If unspecified, defaults to `15`. @return [Integer]

set_http_header[RW]

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`. @return [OCI::Waas::Models::Header]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/waas/models/human_interaction_challenge.rb, line 57
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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [BOOLEAN] :is_enabled The value to assign to the {#is_enabled} property @option attributes [String] :action The value to assign to the {#action} property @option attributes [Integer] :failure_threshold The value to assign to the {#failure_threshold} property @option attributes [Integer] :action_expiration_in_seconds The value to assign to the {#action_expiration_in_seconds} property @option attributes [Integer] :failure_threshold_expiration_in_seconds The value to assign to the {#failure_threshold_expiration_in_seconds} property @option attributes [Integer] :interaction_threshold The value to assign to the {#interaction_threshold} property @option attributes [Integer] :recording_period_in_seconds The value to assign to the {#recording_period_in_seconds} property @option attributes [OCI::Waas::Models::Header] :set_http_header The value to assign to the {#set_http_header} property @option attributes [OCI::Waas::Models::BlockChallengeSettings] :challenge_settings The value to assign to the {#challenge_settings} property @option attributes [BOOLEAN] :is_nat_enabled The value to assign to the {#is_nat_enabled} property

# File lib/oci/waas/models/human_interaction_challenge.rb, line 108
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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/waas/models/human_interaction_challenge.rb, line 75
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

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/waas/models/human_interaction_challenge.rb, line 193
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
action=(action) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] action Object to be assigned

# File lib/oci/waas/models/human_interaction_challenge.rb, line 177
def action=(action)
  # rubocop:disable Style/ConditionalAssignment
  if action && !ACTION_ENUM.include?(action)
    OCI.logger.debug("Unknown value for 'action' [" + action + "]. Mapping to 'ACTION_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @action = ACTION_UNKNOWN_ENUM_VALUE
  else
    @action = action
  end
  # rubocop:enable Style/ConditionalAssignment
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/waas/models/human_interaction_challenge.rb, line 232
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/waas/models/human_interaction_challenge.rb, line 212
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/waas/models/human_interaction_challenge.rb, line 221
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() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/waas/models/human_interaction_challenge.rb, line 265
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/waas/models/human_interaction_challenge.rb, line 259
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/waas/models/human_interaction_challenge.rb, line 282
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end