class OCI::Core::Models::DhcpSearchDomainOption
DHCP option for specifying a search domain name for DNS queries. For more information, see [DNS in Your Virtual Cloud Network](docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
Attributes
[Required] A single search domain name according to [RFC 952](tools.ietf.org/html/rfc952) and [RFC 1123](tools.ietf.org/html/rfc1123). During a DNS query, the OS will append this search domain name to the value being queried.
If you set {DhcpDnsOption} to `VcnLocalPlusInternet`, and you assign a DNS label to the VCN during creation, the search domain name in the VCN's default set of DHCP options is automatically set to the VCN domain (for example, `vcn1.oraclevcn.com`).
If you don't want to use a search domain name, omit this option from the set of DHCP options. Do not include this option with an empty list of search domain names, or with an empty string as the value for any search domain name.
@return [Array<String>]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/core/models/dhcp_search_domain_option.rb, line 31 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'type': :'type', 'search_domain_names': :'searchDomainNames' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Array<String>] :search_domain_names The value to assign to the {#search_domain_names} property
OCI::Core::Models::DhcpOption::new
# File lib/oci/core/models/dhcp_search_domain_option.rb, line 57 def initialize(attributes = {}) return unless attributes.is_a?(Hash) attributes['type'] = 'SearchDomain' super(attributes) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.search_domain_names = attributes[:'searchDomainNames'] if attributes[:'searchDomainNames'] raise 'You cannot provide both :searchDomainNames and :search_domain_names' if attributes.key?(:'searchDomainNames') && attributes.key?(:'search_domain_names') self.search_domain_names = attributes[:'search_domain_names'] if attributes[:'search_domain_names'] end
Attribute type mapping.
# File lib/oci/core/models/dhcp_search_domain_option.rb, line 41 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'type': :'String', 'search_domain_names': :'Array<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/core/models/dhcp_search_domain_option.rb, line 81 def ==(other) return true if equal?(other) self.class == other.class && type == other.type && search_domain_names == other.search_domain_names 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/core/models/dhcp_search_domain_option.rb, line 112 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/core/models/dhcp_search_domain_option.rb, line 92 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/core/models/dhcp_search_domain_option.rb, line 101 def hash [type, search_domain_names].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/core/models/dhcp_search_domain_option.rb, line 145 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/core/models/dhcp_search_domain_option.rb, line 139 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/core/models/dhcp_search_domain_option.rb, line 162 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