class OCI::LoadBalancer::Models::AllowRule
An object that represents the action of configuring an access control rule. Access control rules permit access to application resources based on user-specified match conditions. This rule applies only to HTTP listeners.
NOTES:
-
If you do not specify any access control rules, the default rule is to allow all traffic.
-
If you add access control rules, the load balancer denies any traffic that does not match the rules.
-
Maximum of two match conditions can be specified in a rule.
-
You can specify this rule only with the following `RuleCondition` combinations:
* `SOURCE_IP_ADDRESS` * `SOURCE_VCN_ID` * `SOURCE_VCN_ID\", \"SOURCE_VCN_IP_ADDRESS`
Attributes
This attribute is required. @return [Array<OCI::LoadBalancer::Models::RuleCondition>]
A brief description of the access control rule. Avoid entering confidential information.
example: `192.168.0.0/16 and 2001:db8::/32 are trusted clients. Whitelist them.`
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/load_balancer/models/allow_rule.rb, line 34 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'action': :'action', 'conditions': :'conditions', 'description': :'description' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Array<OCI::LoadBalancer::Models::RuleCondition>] :conditions The value to assign to the {#conditions} property @option attributes [String] :description The value to assign to the {#description} property
OCI::LoadBalancer::Models::Rule::new
# File lib/oci/load_balancer/models/allow_rule.rb, line 63 def initialize(attributes = {}) return unless attributes.is_a?(Hash) attributes['action'] = 'ALLOW' super(attributes) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.conditions = attributes[:'conditions'] if attributes[:'conditions'] self.description = attributes[:'description'] if attributes[:'description'] end
Attribute type mapping.
# File lib/oci/load_balancer/models/allow_rule.rb, line 45 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'action': :'String', 'conditions': :'Array<OCI::LoadBalancer::Models::RuleCondition>', 'description': :'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/load_balancer/models/allow_rule.rb, line 85 def ==(other) return true if equal?(other) self.class == other.class && action == other.action && conditions == other.conditions && description == other.description 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/load_balancer/models/allow_rule.rb, line 117 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/load_balancer/models/allow_rule.rb, line 97 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/load_balancer/models/allow_rule.rb, line 106 def hash [action, conditions, description].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/load_balancer/models/allow_rule.rb, line 150 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/load_balancer/models/allow_rule.rb, line 144 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/load_balancer/models/allow_rule.rb, line 167 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