class OCI::Core::Models::DhcpDnsOption

DHCP option for specifying how DNS (hostname resolution) is handled in the subnets in the VCN. For more information, see [DNS in Your Virtual Cloud Network](docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).

Constants

SERVER_TYPE_ENUM

Attributes

custom_dns_servers[RW]

If you set `serverType` to `CustomDnsServer`, specify the IP address of at least one DNS server of your choice (three maximum).

@return [Array<String>]

server_type[R]

[Required] * VcnLocal: Reserved for future use.

  • VcnLocalPlusInternet: Also referred to as "Internet and VCN Resolver".

Instances can resolve internet hostnames (no internet gateway is required), and can resolve hostnames of instances in the VCN. This is the default value in the default set of DHCP options in the VCN. For the Internet and VCN Resolver to work across the VCN, there must also be a DNS label set for the VCN, a DNS label set for each subnet, and a hostname for each instance. The Internet and VCN Resolver also enables reverse DNS lookup, which lets you determine the hostname corresponding to the private IP address. For more information, see [DNS in Your Virtual Cloud Network](docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).

  • CustomDnsServer: Instances use a DNS server of your choice (three

maximum).

@return [String]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/oci/core/models/dhcp_dns_option.rb, line 48
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'custom_dns_servers': :'customDnsServers',
    'server_type': :'serverType'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Array<String>] :custom_dns_servers The value to assign to the {#custom_dns_servers} property @option attributes [String] :server_type The value to assign to the {#server_type} property

Calls superclass method OCI::Core::Models::DhcpOption::new
# File lib/oci/core/models/dhcp_dns_option.rb, line 77
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'DomainNameServer'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.custom_dns_servers = attributes[:'customDnsServers'] if attributes[:'customDnsServers']

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

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

  self.server_type = attributes[:'serverType'] if attributes[:'serverType']

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

  self.server_type = attributes[:'server_type'] if attributes[:'server_type']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/core/models/dhcp_dns_option.rb, line 59
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'custom_dns_servers': :'Array<String>',
    'server_type': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/core/models/dhcp_dns_option.rb, line 120
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    type == other.type &&
    custom_dns_servers == other.custom_dns_servers &&
    server_type == other.server_type
end
build_from_hash(attributes) click to toggle source

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_dns_option.rb, line 152
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/core/models/dhcp_dns_option.rb, line 132
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/core/models/dhcp_dns_option.rb, line 141
def hash
  [type, custom_dns_servers, server_type].hash
end
server_type=(server_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] server_type Object to be assigned

# File lib/oci/core/models/dhcp_dns_option.rb, line 104
def server_type=(server_type)
  # rubocop:disable Style/ConditionalAssignment
  if server_type && !SERVER_TYPE_ENUM.include?(server_type)
    OCI.logger.debug("Unknown value for 'server_type' [" + server_type + "]. Mapping to 'SERVER_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @server_type = SERVER_TYPE_UNKNOWN_ENUM_VALUE
  else
    @server_type = server_type
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/core/models/dhcp_dns_option.rb, line 185
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/core/models/dhcp_dns_option.rb, line 179
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

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_dns_option.rb, line 202
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