Class: OCI::Core::Models::CreateVnicDetails

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateVnicDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 90

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

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

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

  if attributes[:'privateIp']
    self.private_ip = attributes[:'privateIp']
  end

  if attributes[:'skipSourceDestCheck']
    self.skip_source_dest_check = attributes[:'skipSourceDestCheck']
  end

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

end

Instance Attribute Details

#assign_public_ip ⇒ BOOLEAN

Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where ‘prohibitPublicIpOnVnic` = true in the Subnet), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and `prohibitPublicIpOnVnic` = true, an error is returned.

Note: This public IP address is associated with the primary private IP on the VNIC. Secondary private IPs cannot have public IP addresses associated with them. For more information, see [IP Addresses](docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPaddresses.htm).

Example: ‘false`

Returns:

  • (BOOLEAN) 


23
24
25
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 23

def assign_public_ip
  @assign_public_ip
end

#display_name ⇒ String

A user-friendly name for the VNIC. Does not have to be unique. Avoid entering confidential information.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 29

def display_name
  @display_name
end

#hostname_label ⇒ String

The hostname for the VNIC’s primary private IP. Used for DNS. The value is the hostname portion of the primary 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). The value appears in the Vnic object and also the PrivateIp object returned by list_private_ips and get_private_ip.

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

When launching an instance, use this ‘hostnameLabel` instead of the deprecated `hostnameLabel` in launch_instance_details. If you provide both, the values must match.

Example: ‘bminstance-1`

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 53

def hostname_label
  @hostname_label
end

#private_ip ⇒ String

A private IP address of your choice to assign to the VNIC. 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. This is the VNIC’s primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by list_private_ips and get_private_ip.

Example: ‘10.0.3.3`

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 67

def private_ip
  @private_ip
end

#skip_source_dest_check ⇒ BOOLEAN

Whether the source/destination check is disabled on the VNIC. Defaults to ‘false`, which means the check is performed. For information about why you would skip the source/destination check, see [Using a Private IP as a Route Target](docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingroutetables.htm#privateip).

Example: ‘true`

Returns:

  • (BOOLEAN) 


77
78
79
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 77

def skip_source_dest_check
  @skip_source_dest_check
end

#subnet_id ⇒ String

The OCID of the subnet to create the VNIC in. When launching an instance, use this ‘subnetId` instead of the deprecated `subnetId` in launch_instance_details. At least one of them is required; if you provide both, the values must match.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 85

def subnet_id
  @subnet_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 124

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      assign_public_ip == other_object.assign_public_ip &&
      display_name == other_object.display_name &&
      hostname_label == other_object.hostname_label &&
      private_ip == other_object.private_ip &&
      skip_source_dest_check == other_object.skip_source_dest_check &&
      subnet_id == other_object.subnet_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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 150

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_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.public_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


137
138
139
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 137

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



143
144
145
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 143

def hash
  [assign_public_ip, display_name, hostname_label, private_ip, skip_source_dest_check, subnet_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 175

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



169
170
171
 
# File 'lib/oci/core/models/create_vnic_details.rb', line 169

def to_s
  to_hash.to_s
end