class OCI::Apigateway::Models::HeaderValidationRequestPolicy

Validate the HTTP headers on the incoming API requests on a specific route.

Constants

VALIDATION_MODE_ENUM

Attributes

headers[RW]

@return [Array<OCI::Apigateway::Models::HeaderValidationItem>]

validation_mode[R]

Validation behavior mode.

In `ENFORCING` mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend.

In `PERMISSIVE` mode, the result of the validation will be exposed as metrics while the request will follow the normal path.

`DISABLED` type turns the validation off.

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/apigateway/models/header_validation_request_policy.rb, line 33
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'headers': :'headers',
    'validation_mode': :'validationMode'
    # 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 [Array<OCI::Apigateway::Models::HeaderValidationItem>] :headers The value to assign to the {#headers} property @option attributes [String] :validation_mode The value to assign to the {#validation_mode} property

# File lib/oci/apigateway/models/header_validation_request_policy.rb, line 60
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.headers = attributes[:'headers'] if attributes[:'headers']

  self.validation_mode = attributes[:'validationMode'] if attributes[:'validationMode']
  self.validation_mode = "ENFORCING" if validation_mode.nil? && !attributes.key?(:'validationMode') # rubocop:disable Style/StringLiterals

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

  self.validation_mode = attributes[:'validation_mode'] if attributes[:'validation_mode']
  self.validation_mode = "ENFORCING" if validation_mode.nil? && !attributes.key?(:'validationMode') && !attributes.key?(:'validation_mode') # rubocop:disable Style/StringLiterals
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/apigateway/models/header_validation_request_policy.rb, line 43
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'headers': :'Array<OCI::Apigateway::Models::HeaderValidationItem>',
    'validation_mode': :'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/apigateway/models/header_validation_request_policy.rb, line 92
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    headers == other.headers &&
    validation_mode == other.validation_mode
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/apigateway/models/header_validation_request_policy.rb, line 123
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/apigateway/models/header_validation_request_policy.rb, line 103
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/apigateway/models/header_validation_request_policy.rb, line 112
def hash
  [headers, validation_mode].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/apigateway/models/header_validation_request_policy.rb, line 156
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/apigateway/models/header_validation_request_policy.rb, line 150
def to_s
  to_hash.to_s
end
validation_mode=(validation_mode) click to toggle source

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

# File lib/oci/apigateway/models/header_validation_request_policy.rb, line 81
def validation_mode=(validation_mode)
  raise "Invalid value for 'validation_mode': this must be one of the values in VALIDATION_MODE_ENUM." if validation_mode && !VALIDATION_MODE_ENUM.include?(validation_mode)

  @validation_mode = validation_mode
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/apigateway/models/header_validation_request_policy.rb, line 173
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