Class: OCI::Core::Models::DhcpOption

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

Overview

A single DHCP option according to [RFC 1533](tools.ietf.org/html/rfc1533). The two options available to use are DhcpDnsOption and DhcpSearchDomainOption. For more information, see [DNS in Your Virtual Cloud Network](docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm) and [DHCP Options](docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingDHCP.htm).

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

Direct Known Subclasses

DhcpDnsOption, DhcpSearchDomainOption

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DhcpOption

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String) —

    The value to assign to the #type property



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

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}

  if attributes[:'type']
    self.type = attributes[:'type']
  end

end

Instance Attribute Details

#type ⇒ String

[Required] The specific DHCP option. Either ‘DomainNameServer` (for OCI::Core::Models::DhcpDnsOption) or `SearchDomain` (for OCI::Core::Models::DhcpSearchDomainOption).

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/core/models/dhcp_option.rb', line 19

def type
  @type
end

Class Method Details

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



24
25
26
27
28
29
30
31
32
 
# File 'lib/oci/core/models/dhcp_option.rb', line 24

def self.get_subtype(object_hash)
  type = object_hash[:'type']

  return 'OCI::Core::Models::DhcpDnsOption' if type == 'DomainNameServer'
  return 'OCI::Core::Models::DhcpSearchDomainOption' if type == 'SearchDomain'

  # TODO: Log a warning when the subtype is not found.
  return 'OCI::Core::Models::DhcpOption'
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



51
52
53
54
55
 
# File 'lib/oci/core/models/dhcp_option.rb', line 51

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/core/models/dhcp_option.rb', line 72

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

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


59
60
61
 
# File 'lib/oci/core/models/dhcp_option.rb', line 59

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



65
66
67
 
# File 'lib/oci/core/models/dhcp_option.rb', line 65

def hash
  [type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



97
98
99
100
101
102
103
104
105
 
# File 'lib/oci/core/models/dhcp_option.rb', line 97

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



91
92
93
 
# File 'lib/oci/core/models/dhcp_option.rb', line 91

def to_s
  to_hash.to_s
end