class OCI::Dns::Models::ResolverRule
A rule for a resolver. Specifying both qnameCoverConditions and clientAddressConditions is not allowed.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
Constants
- ACTION_ENUM
Attributes
[Required] The action determines the behavior of the rule. If a query matches a supplied condition, the action will apply. If there are no conditions on the rule, all queries are subject to the specified action.
-
`FORWARD` - Matching requests will be forwarded from the source interface to the destination address.
@return [String]
[Required] A list of CIDR blocks. The query must come from a client within one of the blocks in order for the rule action to apply.
@return [Array<String>]
[Required] A list of domain names. The query must be covered by one of the domains in order for the rule action to apply.
@return [Array<String>]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/dns/models/resolver_rule.rb, line 39 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'client_address_conditions': :'clientAddressConditions', 'qname_cover_conditions': :'qnameCoverConditions', 'action': :'action' # rubocop:enable Style/SymbolLiteral } end
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
# File lib/oci/dns/models/resolver_rule.rb, line 65 def self.get_subtype(object_hash) type = object_hash[:'action'] # rubocop:disable Style/SymbolLiteral return 'OCI::Dns::Models::ResolverForwardRule' if type == 'FORWARD' # TODO: Log a warning when the subtype is not found. 'OCI::Dns::Models::ResolverRule' end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Array<String>] :client_address_conditions The value to assign to the {#client_address_conditions} property @option attributes [Array<String>] :qname_cover_conditions The value to assign to the {#qname_cover_conditions} property @option attributes [String] :action The value to assign to the {#action} property
# File lib/oci/dns/models/resolver_rule.rb, line 84 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.client_address_conditions = attributes[:'clientAddressConditions'] if attributes[:'clientAddressConditions'] raise 'You cannot provide both :clientAddressConditions and :client_address_conditions' if attributes.key?(:'clientAddressConditions') && attributes.key?(:'client_address_conditions') self.client_address_conditions = attributes[:'client_address_conditions'] if attributes[:'client_address_conditions'] self.qname_cover_conditions = attributes[:'qnameCoverConditions'] if attributes[:'qnameCoverConditions'] raise 'You cannot provide both :qnameCoverConditions and :qname_cover_conditions' if attributes.key?(:'qnameCoverConditions') && attributes.key?(:'qname_cover_conditions') self.qname_cover_conditions = attributes[:'qname_cover_conditions'] if attributes[:'qname_cover_conditions'] self.action = attributes[:'action'] if attributes[:'action'] end
Attribute type mapping.
# File lib/oci/dns/models/resolver_rule.rb, line 50 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'client_address_conditions': :'Array<String>', 'qname_cover_conditions': :'Array<String>', 'action': :'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/dns/models/resolver_rule.rb, line 125 def ==(other) return true if equal?(other) self.class == other.class && client_address_conditions == other.client_address_conditions && qname_cover_conditions == other.qname_cover_conditions && action == other.action end
Custom attribute writer method checking allowed values (enum). @param [Object] action Object
to be assigned
# File lib/oci/dns/models/resolver_rule.rb, line 109 def action=(action) # rubocop:disable Style/ConditionalAssignment if action && !ACTION_ENUM.include?(action) OCI.logger.debug("Unknown value for 'action' [" + action + "]. Mapping to 'ACTION_UNKNOWN_ENUM_VALUE'") if OCI.logger @action = ACTION_UNKNOWN_ENUM_VALUE else @action = action end # rubocop:enable Style/ConditionalAssignment 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/dns/models/resolver_rule.rb, line 157 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/dns/models/resolver_rule.rb, line 137 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/dns/models/resolver_rule.rb, line 146 def hash [client_address_conditions, qname_cover_conditions, action].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/dns/models/resolver_rule.rb, line 190 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/dns/models/resolver_rule.rb, line 184 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/dns/models/resolver_rule.rb, line 207 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