class OCI::Apigateway::Models::RateLimitingPolicy
Limit the number of requests that should be handled for the specified window using a specfic key.
Constants
- RATE_KEY_ENUM
Attributes
[Required] The maximum number of requests per second to allow. @return [Integer]
[Required] The key used to group requests together. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/apigateway/models/rate_limiting_policy.rb, line 26 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'rate_in_requests_per_second': :'rateInRequestsPerSecond', 'rate_key': :'rateKey' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Integer] :rate_in_requests_per_second The value to assign to the {#rate_in_requests_per_second} property @option attributes [String] :rate_key The value to assign to the {#rate_key} property
# File lib/oci/apigateway/models/rate_limiting_policy.rb, line 53 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
Attribute type mapping.
# File lib/oci/apigateway/models/rate_limiting_policy.rb, line 36 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'rate_in_requests_per_second': :'Integer', 'rate_key': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/apigateway/models/rate_limiting_policy.rb, line 92 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
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/rate_limiting_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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/apigateway/models/rate_limiting_policy.rb, line 103 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/apigateway/models/rate_limiting_policy.rb, line 112 def hash [rate_in_requests_per_second, rate_key].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] rate_key
Object
to be assigned
# File lib/oci/apigateway/models/rate_limiting_policy.rb, line 76 def rate_key=(rate_key) # rubocop:disable Style/ConditionalAssignment if rate_key && !RATE_KEY_ENUM.include?(rate_key) OCI.logger.debug("Unknown value for 'rate_key' [" + rate_key + "]. Mapping to 'RATE_KEY_UNKNOWN_ENUM_VALUE'") if OCI.logger @rate_key = RATE_KEY_UNKNOWN_ENUM_VALUE else @rate_key = rate_key end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/apigateway/models/rate_limiting_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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/apigateway/models/rate_limiting_policy.rb, line 150 def to_s to_hash.to_s end
Private Instance Methods
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/rate_limiting_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