Class: OCI::Waf::Models::RequestAccessControl

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/waf/models/request_access_control.rb

Overview

Module that allows inspection of HTTP request properties and to return a defined HTTP response. In this module, rules with the name 'Default Action' are not allowed, since this name is reserved for default action logs.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestAccessControl

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/waf/models/request_access_control.rb', line 54

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

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

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

  self.rules = attributes[:'rules'] if attributes[:'rules']
end

Instance Attribute Details

#default_action_name ⇒ String

[Required] References an default Action to take if no AccessControlRule was matched. Allowed action types:

  • ALLOW continues execution of other modules and their rules.

  • RETURN_HTTP_RESPONSE terminates further execution of modules and rules and returns defined HTTP response.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/waf/models/request_access_control.rb', line 20

def default_action_name
  @default_action_name
end

#rules ⇒ Array<OCI::Waf::Models::AccessControlRule>

Ordered list of AccessControlRules. Rules are executed in order of appearance in this array.

Returns:



24
25
26
 
# File 'lib/oci/waf/models/request_access_control.rb', line 24

def rules
  @rules
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
 
# File 'lib/oci/waf/models/request_access_control.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'default_action_name': :'defaultActionName',
    'rules': :'rules'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
 
# File 'lib/oci/waf/models/request_access_control.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'default_action_name': :'String',
    'rules': :'Array<OCI::Waf::Models::AccessControlRule>'
    # 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



76
77
78
79
80
81
82
 
# File 'lib/oci/waf/models/request_access_control.rb', line 76

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    default_action_name == other.default_action_name &&
    rules == other.rules
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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/waf/models/request_access_control.rb', line 107

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


87
88
89
 
# File 'lib/oci/waf/models/request_access_control.rb', line 87

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



96
97
98
 
# File 'lib/oci/waf/models/request_access_control.rb', line 96

def hash
  [default_action_name, rules].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/waf/models/request_access_control.rb', line 140

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



134
135
136
 
# File 'lib/oci/waf/models/request_access_control.rb', line 134

def to_s
  to_hash.to_s
end