Class: OCI::ContainerInstances::Models::CreateContainerVnicDetails
- Inherits:
-
Object
- Object
- OCI::ContainerInstances::Models::CreateContainerVnicDetails
- Defined in:
- lib/oci/container_instances/models/create_container_vnic_details.rb
Overview
Information to create a virtual network interface card (VNIC) which gives the containers on this container instance access to a virtual client network (VCN).
You use this object when creating the primary VNIC during container instance launch or when creating a secondary VNIC. This VNIC is created in the same compartment as the specified subnet on behalf of the customer.
The VNIC created by this call contains both the tags specified in this object as well as any tags specified in the parent container instance.
Instance Attribute Summary collapse
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
A user-friendly name for the VNIC.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#hostname_label ⇒ String
The hostname for the VNIC's primary private IP.
-
#is_public_ip_assigned ⇒ BOOLEAN
Whether the VNIC should be assigned a public IP address.
-
#nsg_ids ⇒ Array<String>
A list of the OCIDs of the network security groups (NSGs) to add the VNIC to.
-
#private_ip ⇒ String
A private IP address of your choice to assign to the VNIC.
-
#skip_source_dest_check ⇒ BOOLEAN
Whether the source/destination check is disabled on the VNIC.
-
#subnet_id ⇒ String
[Required] The OCID of the subnet to create the VNIC in.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CreateContainerVnicDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ CreateContainerVnicDetails
Initializes the object
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 118 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 } self.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] self.hostname_label = attributes[:'hostnameLabel'] if attributes[:'hostnameLabel'] raise 'You cannot provide both :hostnameLabel and :hostname_label' if attributes.key?(:'hostnameLabel') && attributes.key?(:'hostname_label') self.hostname_label = attributes[:'hostname_label'] if attributes[:'hostname_label'] self.is_public_ip_assigned = attributes[:'isPublicIpAssigned'] unless attributes[:'isPublicIpAssigned'].nil? raise 'You cannot provide both :isPublicIpAssigned and :is_public_ip_assigned' if attributes.key?(:'isPublicIpAssigned') && attributes.key?(:'is_public_ip_assigned') self.is_public_ip_assigned = attributes[:'is_public_ip_assigned'] unless attributes[:'is_public_ip_assigned'].nil? self.skip_source_dest_check = attributes[:'skipSourceDestCheck'] unless attributes[:'skipSourceDestCheck'].nil? self.skip_source_dest_check = false if skip_source_dest_check.nil? && !attributes.key?(:'skipSourceDestCheck') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :skipSourceDestCheck and :skip_source_dest_check' if attributes.key?(:'skipSourceDestCheck') && attributes.key?(:'skip_source_dest_check') self.skip_source_dest_check = attributes[:'skip_source_dest_check'] unless attributes[:'skip_source_dest_check'].nil? self.skip_source_dest_check = false if skip_source_dest_check.nil? && !attributes.key?(:'skipSourceDestCheck') && !attributes.key?(:'skip_source_dest_check') # rubocop:disable Style/StringLiterals self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds'] raise 'You cannot provide both :nsgIds and :nsg_ids' if attributes.key?(:'nsgIds') && attributes.key?(:'nsg_ids') self.nsg_ids = attributes[:'nsg_ids'] if attributes[:'nsg_ids'] self.private_ip = attributes[:'privateIp'] if attributes[:'privateIp'] raise 'You cannot provide both :privateIp and :private_ip' if attributes.key?(:'privateIp') && attributes.key?(:'private_ip') self.private_ip = attributes[:'private_ip'] if attributes[:'private_ip'] self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId'] raise 'You cannot provide both :subnetId and :subnet_id' if attributes.key?(:'subnetId') && attributes.key?(:'subnet_id') self.subnet_id = attributes[:'subnet_id'] if attributes[:'subnet_id'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] end |
Instance Attribute Details
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
.
67 68 69 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 67 def @defined_tags end |
#display_name ⇒ String
A user-friendly name for the VNIC. Does not have to be unique. Avoid entering confidential information.
24 25 26 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 24 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}
61 62 63 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 61 def @freeform_tags end |
#hostname_label ⇒ String
The hostname for the VNIC's primary private IP. Used for DNS.
29 30 31 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 29 def hostname_label @hostname_label end |
#is_public_ip_assigned ⇒ BOOLEAN
Whether the VNIC should be assigned a public IP address.
34 35 36 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 34 def is_public_ip_assigned @is_public_ip_assigned end |
#nsg_ids ⇒ Array<String>
A list of the OCIDs of the network security groups (NSGs) to add the VNIC to.
44 45 46 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 44 def nsg_ids @nsg_ids 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.
50 51 52 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 50 def private_ip @private_ip end |
#skip_source_dest_check ⇒ BOOLEAN
Whether the source/destination check is disabled on the VNIC.
39 40 41 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 39 def skip_source_dest_check @skip_source_dest_check end |
#subnet_id ⇒ String
[Required] The OCID of the subnet to create the VNIC in.
55 56 57 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 55 def subnet_id @subnet_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 70 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'display_name': :'displayName', 'hostname_label': :'hostnameLabel', 'is_public_ip_assigned': :'isPublicIpAssigned', 'skip_source_dest_check': :'skipSourceDestCheck', 'nsg_ids': :'nsgIds', 'private_ip': :'privateIp', 'subnet_id': :'subnetId', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 87 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'display_name': :'String', 'hostname_label': :'String', 'is_public_ip_assigned': :'BOOLEAN', 'skip_source_dest_check': :'BOOLEAN', 'nsg_ids': :'Array<String>', 'private_ip': :'String', 'subnet_id': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 188 def ==(other) return true if equal?(other) self.class == other.class && display_name == other.display_name && hostname_label == other.hostname_label && is_public_ip_assigned == other.is_public_ip_assigned && skip_source_dest_check == other.skip_source_dest_check && nsg_ids == other.nsg_ids && private_ip == other.private_ip && subnet_id == other.subnet_id && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 226 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) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? 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) ⇒ Boolean
206 207 208 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 206 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
215 216 217 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 215 def hash [display_name, hostname_label, is_public_ip_assigned, skip_source_dest_check, nsg_ids, private_ip, subnet_id, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
259 260 261 262 263 264 265 266 267 268 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 259 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
253 254 255 |
# File 'lib/oci/container_instances/models/create_container_vnic_details.rb', line 253 def to_s to_hash.to_s end |