Class: OCI::Apigateway::Models::RateLimitingPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apigateway/models/rate_limiting_policy.rb

Overview

Limit the number of requests that should be handled for the specified window using a specfic key.

Constant Summary collapse

RATE_KEY_ENUM = 
[
  RATE_KEY_CLIENT_IP = 'CLIENT_IP'.freeze,
  RATE_KEY_TOTAL = 'TOTAL'.freeze,
  RATE_KEY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RateLimitingPolicy

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
68
69
70
71
 
# File 'lib/oci/apigateway/models/rate_limiting_policy.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.rate_in_requests_per_second = attributes[:'rateInRequestsPerSecond'] if attributes[:'rateInRequestsPerSecond']

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

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

  self.rate_key = attributes[:'rateKey'] if attributes[:'rateKey']

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

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

Instance Attribute Details

#rate_in_requests_per_second ⇒ Integer

[Required] The maximum number of requests per second to allow.

Returns:

  • (Integer) 


20
21
22
 
# File 'lib/oci/apigateway/models/rate_limiting_policy.rb', line 20

def rate_in_requests_per_second
  @rate_in_requests_per_second
end

#rate_key ⇒ String

[Required] The key used to group requests together.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/apigateway/models/rate_limiting_policy.rb', line 24

def rate_key
  @rate_key
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/apigateway/models/rate_limiting_policy.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'rate_in_requests_per_second': :'rateInRequestsPerSecond',
    'rate_key': :'rateKey'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'rate_in_requests_per_second': :'Integer',
    'rate_key': :'String'
    # 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



93
94
95
96
97
98
99
 
# File 'lib/oci/apigateway/models/rate_limiting_policy.rb', line 93

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

  self.class == other.class &&
    rate_in_requests_per_second == other.rate_in_requests_per_second &&
    rate_key == other.rate_key
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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/oci/apigateway/models/rate_limiting_policy.rb', line 124

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


104
105
106
 
# File 'lib/oci/apigateway/models/rate_limiting_policy.rb', line 104

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



113
114
115
 
# File 'lib/oci/apigateway/models/rate_limiting_policy.rb', line 113

def hash
  [rate_in_requests_per_second, rate_key].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/apigateway/models/rate_limiting_policy.rb', line 157

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



151
152
153
 
# File 'lib/oci/apigateway/models/rate_limiting_policy.rb', line 151

def to_s
  to_hash.to_s
end