Class: OCI::Core::Models::DhcpSearchDomainOption

Inherits:
DhcpOption
  • Object
show all
Defined in:
lib/oci/core/models/dhcp_search_domain_option.rb

Overview

DHCP option for specifying a search domain name for DNS queries. For more information, see [DNS in Your Virtual Cloud Network](docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).

Instance Attribute Summary collapse

Attributes inherited from DhcpOption

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DhcpOption

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DhcpSearchDomainOption

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/core/models/dhcp_search_domain_option.rb', line 56

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

Instance Attribute Details

#search_domain_names ⇒ Array<String>

[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 OCI::Core::Models::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.

Returns:

  • (Array<String>) 


27
28
29
 
# File 'lib/oci/core/models/dhcp_search_domain_option.rb', line 27

def search_domain_names
  @search_domain_names
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
 
# File 'lib/oci/core/models/dhcp_search_domain_option.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'search_domain_names': :'searchDomainNames'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
 
# File 'lib/oci/core/models/dhcp_search_domain_option.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'search_domain_names': :'Array<String>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



80
81
82
83
84
85
 
# File 'lib/oci/core/models/dhcp_search_domain_option.rb', line 80

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    type == other.type &&
    search_domain_names == other.search_domain_names
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/core/models/dhcp_search_domain_option.rb', line 110

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) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


90
91
92
 
# File 'lib/oci/core/models/dhcp_search_domain_option.rb', line 90

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



99
100
101
 
# File 'lib/oci/core/models/dhcp_search_domain_option.rb', line 99

def hash
  [type, search_domain_names].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/core/models/dhcp_search_domain_option.rb', line 142

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



136
137
138
 
# File 'lib/oci/core/models/dhcp_search_domain_option.rb', line 136

def to_s
  to_hash.to_s
end