Class: OCI::Core::Models::PrivateIp

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PrivateIp

Initializes the object

Parameters:

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

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/core/models/private_ip.rb', line 79

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

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end

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

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

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

  if attributes[:'isPrimary']
    self.is_primary = attributes[:'isPrimary']
  end

  if attributes[:'subnetId']
    self.subnet_id = attributes[:'subnetId']
  end

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

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

end

Instance Attribute Details

#availability_domain ⇒ String

The private IP’s Availability Domain.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


12
13
14
 
# File 'lib/oci/core/models/private_ip.rb', line 12

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

The OCID of the compartment containing the private IP.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/core/models/private_ip.rb', line 16

def compartment_id
  @compartment_id
end

#display_name ⇒ String

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

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/core/models/private_ip.rb', line 22

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`

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/core/models/private_ip.rb', line 37

def hostname_label
  @hostname_label
end

#id ⇒ String

The private IP’s Oracle ID (OCID).

Returns:

  • (String) 


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

def id
  @id
end

#ip_address ⇒ String

The private IP address of the ‘privateIp` object. The address is within the CIDR of the VNIC’s subnet.

Example: ‘10.0.3.3`

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/core/models/private_ip.rb', line 49

def ip_address
  @ip_address
end

#is_primary ⇒ BOOLEAN

Whether this private IP is the primary one on the VNIC. Primary private IPs are unassigned and deleted automatically when the VNIC is terminated.

Example: ‘true`

Returns:

  • (BOOLEAN) 


57
58
59
 
# File 'lib/oci/core/models/private_ip.rb', line 57

def is_primary
  @is_primary
end

#subnet_id ⇒ String

The OCID of the subnet the VNIC is in.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/core/models/private_ip.rb', line 61

def subnet_id
  @subnet_id
end

#time_created ⇒ DateTime

The date and time the private IP was created, in the format defined by RFC3339.

Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/core/models/private_ip.rb', line 68

def time_created
  @time_created
end

#vnic_id ⇒ String

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

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/core/models/private_ip.rb', line 74

def vnic_id
  @vnic_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/core/models/private_ip.rb', line 129

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      availability_domain == other_object.availability_domain &&
      compartment_id == other_object.compartment_id &&
      display_name == other_object.display_name &&
      hostname_label == other_object.hostname_label &&
      id == other_object.id &&
      ip_address == other_object.ip_address &&
      is_primary == other_object.is_primary &&
      subnet_id == other_object.subnet_id &&
      time_created == other_object.time_created &&
      vnic_id == other_object.vnic_id
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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/core/models/private_ip.rb', line 159

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

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


146
147
148
 
# File 'lib/oci/core/models/private_ip.rb', line 146

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



152
153
154
 
# File 'lib/oci/core/models/private_ip.rb', line 152

def hash
  [availability_domain, compartment_id, display_name, hostname_label, id, ip_address, is_primary, subnet_id, time_created, vnic_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/core/models/private_ip.rb', line 184

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



178
179
180
 
# File 'lib/oci/core/models/private_ip.rb', line 178

def to_s
  to_hash.to_s
end