Class: OracleBMC::Core::Models::DhcpSearchDomainOption

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

Instance Attribute Summary collapse

Attributes inherited from DhcpOption

#type

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



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/oraclebmc/core/models/dhcp_search_domain_option.rb', line 29

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}

  
  if attributes[:'searchDomainNames']
    self.search_domain_names = attributes[:'searchDomainNames']
  end
  
end

Instance Attribute Details

#search_domain_names ⇒ Array<String>

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, but only if that value is not a fully qualified domain name (FQDN).

If you set OracleBMC::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 (e.g., ‘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>) 


24
25
26
 
# File 'lib/oraclebmc/core/models/dhcp_search_domain_option.rb', line 24

def search_domain_names
  @search_domain_names
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



48
49
50
51
52
53
 
# File 'lib/oraclebmc/core/models/dhcp_search_domain_option.rb', line 48

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      type == other_object.type &&
      search_domain_names == other_object.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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oraclebmc/core/models/dhcp_search_domain_option.rb', line 70

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)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| OracleBMC::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", OracleBMC::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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


57
58
59
 
# File 'lib/oraclebmc/core/models/dhcp_search_domain_option.rb', line 57

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



63
64
65
 
# File 'lib/oraclebmc/core/models/dhcp_search_domain_option.rb', line 63

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



95
96
97
98
99
100
101
102
103
 
# File 'lib/oraclebmc/core/models/dhcp_search_domain_option.rb', line 95

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



89
90
91
 
# File 'lib/oraclebmc/core/models/dhcp_search_domain_option.rb', line 89

def to_s
  to_hash.to_s
end