Class: OCI::Waas::Models::AddressRateLimiting

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

Overview

The IP rate limiting configuration. Defines the amount of allowed requests from a unique IP address and the resulting block response code when that threshold is exceeded.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AddressRateLimiting

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/waas/models/address_rate_limiting.rb', line 61

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

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

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

  self.max_delayed_count_per_address = attributes[:'maxDelayedCountPerAddress'] if attributes[:'maxDelayedCountPerAddress']

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

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

  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']
end

Instance Attribute Details

#allowed_rate_per_address ⇒ Integer

The number of allowed requests per second from one IP address. If unspecified, defaults to 1.

Returns:

  • (Integer) 


17
18
19
 
# File 'lib/oci/waas/models/address_rate_limiting.rb', line 17

def allowed_rate_per_address
  @allowed_rate_per_address
end

#block_response_code ⇒ Integer

The response status code returned when a request is blocked. If unspecified, defaults to 503. The list of available response codes: 400, 401, 403, 404, 405, 408, 409, 411, 412, 413, 414, 415, 416, 422, 494, 495, 496, 497, 499, 500, 501, 502, 503, 504, 507.

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/oci/waas/models/address_rate_limiting.rb', line 25

def block_response_code
  @block_response_code
end

#is_enabled ⇒ BOOLEAN

[Required] Enables or disables the address rate limiting Web Application Firewall feature.

Returns:

  • (BOOLEAN) 


13
14
15
 
# File 'lib/oci/waas/models/address_rate_limiting.rb', line 13

def is_enabled
  @is_enabled
end

#max_delayed_count_per_address ⇒ Integer

The maximum number of requests allowed to be queued before subsequent requests are dropped. If unspecified, defaults to 10.

Returns:

  • (Integer) 


21
22
23
 
# File 'lib/oci/waas/models/address_rate_limiting.rb', line 21

def max_delayed_count_per_address
  @max_delayed_count_per_address
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
37
 
# File 'lib/oci/waas/models/address_rate_limiting.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_enabled': :'isEnabled',
    'allowed_rate_per_address': :'allowedRatePerAddress',
    'max_delayed_count_per_address': :'maxDelayedCountPerAddress',
    'block_response_code': :'blockResponseCode'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/waas/models/address_rate_limiting.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_enabled': :'BOOLEAN',
    'allowed_rate_per_address': :'Integer',
    'max_delayed_count_per_address': :'Integer',
    'block_response_code': :'Integer'
    # 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



99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/waas/models/address_rate_limiting.rb', line 99

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

  self.class == other.class &&
    is_enabled == other.is_enabled &&
    allowed_rate_per_address == other.allowed_rate_per_address &&
    max_delayed_count_per_address == other.max_delayed_count_per_address &&
    block_response_code == other.block_response_code
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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/waas/models/address_rate_limiting.rb', line 132

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


112
113
114
 
# File 'lib/oci/waas/models/address_rate_limiting.rb', line 112

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



121
122
123
 
# File 'lib/oci/waas/models/address_rate_limiting.rb', line 121

def hash
  [is_enabled, allowed_rate_per_address, max_delayed_count_per_address, block_response_code].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/waas/models/address_rate_limiting.rb', line 165

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



159
160
161
 
# File 'lib/oci/waas/models/address_rate_limiting.rb', line 159

def to_s
  to_hash.to_s
end