Class: OCI::Core::Models::CreatePrivateIpDetails

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePrivateIpDetails

Initializes the object



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 46

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[:'displayName']
    self.display_name = attributes[:'displayName']
  end

  if attributes[:'hostnameLabel']
    self.hostname_label = attributes[:'hostnameLabel']
  end

  if attributes[:'ipAddress']
    self.ip_address = attributes[:'ipAddress']
  end

  if attributes[:'vnicId']
    self.vnic_id = attributes[:'vnicId']
  end

end

Instance Attribute Details

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.



11
12
13
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 11

def display_name
  @display_name
end

#hostname_label ⇒ String

The hostname for the private IP. Used for DNS. The value is the hostname portion of the private IP’s fully qualified domain name (FQDN) (for example, ‘bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with [RFC 952](tools.ietf.org/html/rfc952) and [RFC 1123](tools.ietf.org/html/rfc1123).

For more information, see [DNS in Your Virtual Cloud Network](docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).

Example: ‘bminstance-1`



26
27
28
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 26

def hostname_label
  @hostname_label
end

#ip_address ⇒ String

A private IP address of your choice. Must be an available IP address within the subnet’s CIDR. If you don’t specify a value, Oracle automatically assigns a private IP address from the subnet.

Example: ‘10.0.3.3`



35
36
37
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 35

def ip_address
  @ip_address
end

#vnic_id ⇒ String

The OCID of the VNIC to assign the private IP to. The VNIC and private IP must be in the same subnet.



41
42
43
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 41

def vnic_id
  @vnic_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.



72
73
74
75
76
77
78
79
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 72

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      display_name == other_object.display_name &&
      hostname_label == other_object.hostname_label &&
      ip_address == other_object.ip_address &&
      vnic_id == other_object.vnic_id
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 96

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

See Also:

  • `==` method


83
84
85
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 83

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



89
90
91
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 89

def hash
  [display_name, hostname_label, ip_address, vnic_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 121

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



115
116
117
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 115

def to_s
  to_hash.to_s
end