class OCI::Waas::Models::BlockChallengeSettings

The challenge settings if `action` is set to `BLOCK`.

Constants

BLOCK_ACTION_ENUM

Attributes

block_action[R]

The method used to block requests that fail the challenge, if `action` is set to `BLOCK`. If unspecified, defaults to `SHOW_ERROR_PAGE`. @return [String]

block_error_page_code[RW]

The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE` and the request is blocked. If unspecified, defaults to `403`. @return [String]

block_error_page_description[RW]

The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `Access blocked by website owner. Please contact support.` @return [String]

block_error_page_message[RW]

The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `Access to the website is blocked`. @return [String]

block_response_code[RW]

The response status code to return when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE` or `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `403`. The list of available response codes: `200`, `201`, `202`, `204`, `206`, `300`, `301`, `302`, `303`, `304`, `307`, `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `444`, `494`, `495`, `496`, `497`, `499`, `500`, `501`, `502`, `503`, `504`, `507`. @return [Integer]

captcha_header[RW]

The text to show in the header when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.` @return [String]

captcha_submit_label[RW]

The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Yes, I am human`. @return [String]

captcha_title[RW]

The title used when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Are you human?` @return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/waas/models/block_challenge_settings.rb, line 55
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'block_action': :'blockAction',
    'block_response_code': :'blockResponseCode',
    'block_error_page_message': :'blockErrorPageMessage',
    'block_error_page_description': :'blockErrorPageDescription',
    'block_error_page_code': :'blockErrorPageCode',
    'captcha_title': :'captchaTitle',
    'captcha_header': :'captchaHeader',
    'captcha_footer': :'captchaFooter',
    'captcha_submit_label': :'captchaSubmitLabel'
    # 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 [String] :block_action The value to assign to the {#block_action} property @option attributes [Integer] :block_response_code The value to assign to the {#block_response_code} property @option attributes [String] :block_error_page_message The value to assign to the {#block_error_page_message} property @option attributes [String] :block_error_page_description The value to assign to the {#block_error_page_description} property @option attributes [String] :block_error_page_code The value to assign to the {#block_error_page_code} property @option attributes [String] :captcha_title The value to assign to the {#captcha_title} property @option attributes [String] :captcha_header The value to assign to the {#captcha_header} property @option attributes [String] :captcha_footer The value to assign to the {#captcha_footer} property @option attributes [String] :captcha_submit_label The value to assign to the {#captcha_submit_label} property

# File lib/oci/waas/models/block_challenge_settings.rb, line 103
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.block_action = attributes[:'blockAction'] if attributes[:'blockAction']

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

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

  self.block_response_code = attributes[:'blockResponseCode'] if attributes[:'blockResponseCode']

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

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

  self.block_error_page_message = attributes[:'blockErrorPageMessage'] if attributes[:'blockErrorPageMessage']

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

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

  self.block_error_page_description = attributes[:'blockErrorPageDescription'] if attributes[:'blockErrorPageDescription']

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

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

  self.block_error_page_code = attributes[:'blockErrorPageCode'] if attributes[:'blockErrorPageCode']

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

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

  self.captcha_title = attributes[:'captchaTitle'] if attributes[:'captchaTitle']

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

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

  self.captcha_header = attributes[:'captchaHeader'] if attributes[:'captchaHeader']

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

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

  self.captcha_footer = attributes[:'captchaFooter'] if attributes[:'captchaFooter']

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

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

  self.captcha_submit_label = attributes[:'captchaSubmitLabel'] if attributes[:'captchaSubmitLabel']

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

  self.captcha_submit_label = attributes[:'captcha_submit_label'] if attributes[:'captcha_submit_label']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/waas/models/block_challenge_settings.rb, line 72
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'block_action': :'String',
    'block_response_code': :'Integer',
    'block_error_page_message': :'String',
    'block_error_page_description': :'String',
    'block_error_page_code': :'String',
    'captcha_title': :'String',
    'captcha_header': :'String',
    'captcha_footer': :'String',
    'captcha_submit_label': :'String'
    # 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/block_challenge_settings.rb, line 184
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    block_action == other.block_action &&
    block_response_code == other.block_response_code &&
    block_error_page_message == other.block_error_page_message &&
    block_error_page_description == other.block_error_page_description &&
    block_error_page_code == other.block_error_page_code &&
    captcha_title == other.captcha_title &&
    captcha_header == other.captcha_header &&
    captcha_footer == other.captcha_footer &&
    captcha_submit_label == other.captcha_submit_label
end
block_action=(block_action) click to toggle source

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

# File lib/oci/waas/models/block_challenge_settings.rb, line 168
def block_action=(block_action)
  # rubocop:disable Style/ConditionalAssignment
  if block_action && !BLOCK_ACTION_ENUM.include?(block_action)
    OCI.logger.debug("Unknown value for 'block_action' [" + block_action + "]. Mapping to 'BLOCK_ACTION_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @block_action = BLOCK_ACTION_UNKNOWN_ENUM_VALUE
  else
    @block_action = block_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/block_challenge_settings.rb, line 222
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/block_challenge_settings.rb, line 202
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/block_challenge_settings.rb, line 211
def hash
  [block_action, block_response_code, block_error_page_message, block_error_page_description, block_error_page_code, captcha_title, captcha_header, captcha_footer, captcha_submit_label].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/block_challenge_settings.rb, line 255
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/block_challenge_settings.rb, line 249
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/block_challenge_settings.rb, line 272
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