Class: OCI::Core::Models::InstanceConfigurationCreateVnicDetails

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

Overview

Contains the properties of the VNIC for an instance configuration. See CreateVnicDetails} and {Instance Configurations for more information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstanceConfigurationCreateVnicDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 188

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.assign_ipv6_ip = attributes[:'assignIpv6Ip'] unless attributes[:'assignIpv6Ip'].nil?
  self.assign_ipv6_ip = false if assign_ipv6_ip.nil? && !attributes.key?(:'assignIpv6Ip') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :assignIpv6Ip and :assign_ipv6_ip' if attributes.key?(:'assignIpv6Ip') && attributes.key?(:'assign_ipv6_ip')

  self.assign_ipv6_ip = attributes[:'assign_ipv6_ip'] unless attributes[:'assign_ipv6_ip'].nil?
  self.assign_ipv6_ip = false if assign_ipv6_ip.nil? && !attributes.key?(:'assignIpv6Ip') && !attributes.key?(:'assign_ipv6_ip') # rubocop:disable Style/StringLiterals

  self.assign_public_ip = attributes[:'assignPublicIp'] unless attributes[:'assignPublicIp'].nil?

  raise 'You cannot provide both :assignPublicIp and :assign_public_ip' if attributes.key?(:'assignPublicIp') && attributes.key?(:'assign_public_ip')

  self.assign_public_ip = attributes[:'assign_public_ip'] unless attributes[:'assign_public_ip'].nil?

  self.assign_private_dns_record = attributes[:'assignPrivateDnsRecord'] unless attributes[:'assignPrivateDnsRecord'].nil?

  raise 'You cannot provide both :assignPrivateDnsRecord and :assign_private_dns_record' if attributes.key?(:'assignPrivateDnsRecord') && attributes.key?(:'assign_private_dns_record')

  self.assign_private_dns_record = attributes[:'assign_private_dns_record'] unless attributes[:'assign_private_dns_record'].nil?

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  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.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.security_attributes = attributes[:'securityAttributes'] if attributes[:'securityAttributes']

  raise 'You cannot provide both :securityAttributes and :security_attributes' if attributes.key?(:'securityAttributes') && attributes.key?(:'security_attributes')

  self.security_attributes = attributes[:'security_attributes'] if attributes[:'security_attributes']

  self.ipv6_address_ipv6_subnet_cidr_pair_details = attributes[:'ipv6AddressIpv6SubnetCidrPairDetails'] if attributes[:'ipv6AddressIpv6SubnetCidrPairDetails']

  raise 'You cannot provide both :ipv6AddressIpv6SubnetCidrPairDetails and :ipv6_address_ipv6_subnet_cidr_pair_details' if attributes.key?(:'ipv6AddressIpv6SubnetCidrPairDetails') && attributes.key?(:'ipv6_address_ipv6_subnet_cidr_pair_details')

  self.ipv6_address_ipv6_subnet_cidr_pair_details = attributes[:'ipv6_address_ipv6_subnet_cidr_pair_details'] if attributes[:'ipv6_address_ipv6_subnet_cidr_pair_details']

  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.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.subnet_cidr = attributes[:'subnetCidr'] if attributes[:'subnetCidr']

  raise 'You cannot provide both :subnetCidr and :subnet_cidr' if attributes.key?(:'subnetCidr') && attributes.key?(:'subnet_cidr')

  self.subnet_cidr = attributes[:'subnet_cidr'] if attributes[:'subnet_cidr']

  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.private_ip_id = attributes[:'privateIpId'] if attributes[:'privateIpId']

  raise 'You cannot provide both :privateIpId and :private_ip_id' if attributes.key?(:'privateIpId') && attributes.key?(:'private_ip_id')

  self.private_ip_id = attributes[:'private_ip_id'] if attributes[:'private_ip_id']

  self.skip_source_dest_check = attributes[:'skipSourceDestCheck'] unless attributes[:'skipSourceDestCheck'].nil?

  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.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']
end

Instance Attribute Details

#assign_ipv6_ip ⇒ BOOLEAN

Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (ipv6SubnetCidr) of your choice to assign the IPv6 address from. If ipv6SubnetCidr is not provided then an IPv6 prefix is chosen for you.

Returns:

  • (BOOLEAN) 


20
21
22
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 20

def assign_ipv6_ip
  @assign_ipv6_ip
end

#assign_private_dns_record ⇒ BOOLEAN

Whether the VNIC should be assigned a private DNS record. See the assignPrivateDnsRecord attribute of CreateVnicDetails for more information.

Returns:

  • (BOOLEAN) 


32
33
34
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 32

def assign_private_dns_record
  @assign_private_dns_record
end

#assign_public_ip ⇒ BOOLEAN

Whether the VNIC should be assigned a public IP address. See the assignPublicIp attribute of CreateVnicDetails for more information.

Returns:

  • (BOOLEAN) 


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

def assign_public_ip
  @assign_public_ip
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


40
41
42
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 40

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 46

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


54
55
56
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 54

def freeform_tags
  @freeform_tags
end

#hostname_label ⇒ String

The hostname for the VNIC's primary private IP. See the hostnameLabel attribute of CreateVnicDetails for more information.

Returns:

  • (String) 


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

def hostname_label
  @hostname_label
end

#ipv6_address_ipv6_subnet_cidr_pair_details ⇒ Array<OCI::Core::Models::InstanceConfigurationIpv6AddressIpv6SubnetCidrPairDetails>

A list of IPv6 prefixes from which the VNIC should be assigned an IPv6 address. You can provide only the prefix and OCI selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.

Returns:



71
72
73
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 71

def ipv6_address_ipv6_subnet_cidr_pair_details
  @ipv6_address_ipv6_subnet_cidr_pair_details
end

#nsg_ids ⇒ Array<String>

A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see NetworkSecurityGroup.

Returns:

  • (Array<String>) 


84
85
86
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 84

def nsg_ids
  @nsg_ids
end

#private_ip ⇒ String

A private IP address of your choice to assign to the VNIC. See the privateIp attribute of CreateVnicDetails for more information.

Returns:

  • (String) 


101
102
103
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 101

def private_ip
  @private_ip
end

#private_ip_id ⇒ String

An OCID that specifies a previously-reserved IP address to use for this VNIC. See the privateIpId attribute of CreateVnicDetails for more information.

Returns:

  • (String) 


107
108
109
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 107

def private_ip_id
  @private_ip_id
end

#security_attributes ⇒ Hash<String, Hash<String, Object>>

Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources.

Example: {\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


63
64
65
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 63

def security_attributes
  @security_attributes
end

#skip_source_dest_check ⇒ BOOLEAN

Whether the source/destination check is disabled on the VNIC. See the skipSourceDestCheck attribute of CreateVnicDetails for more information.

Returns:

  • (BOOLEAN) 


113
114
115
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 113

def skip_source_dest_check
  @skip_source_dest_check
end

#subnet_cidr ⇒ String

One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC's private IP address will be assigned if privateIp or privateIpId is not specified. Either this field or the privateIp (or privateIpId, if applicable) field must be provided, but not both simultaneously. Example: 192.168.1.0/28 See the subnetCidr attribute of CreateVnicDetails for more information.

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 95

def subnet_cidr
  @subnet_cidr
end

#subnet_id ⇒ String

The OCID of the subnet to create the VNIC in. See the subnetId attribute of CreateVnicDetails for more information.

Returns:

  • (String) 


119
120
121
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 119

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 122

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'assign_ipv6_ip': :'assignIpv6Ip',
    'assign_public_ip': :'assignPublicIp',
    'assign_private_dns_record': :'assignPrivateDnsRecord',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'security_attributes': :'securityAttributes',
    'ipv6_address_ipv6_subnet_cidr_pair_details': :'ipv6AddressIpv6SubnetCidrPairDetails',
    'hostname_label': :'hostnameLabel',
    'nsg_ids': :'nsgIds',
    'subnet_cidr': :'subnetCidr',
    'private_ip': :'privateIp',
    'private_ip_id': :'privateIpId',
    'skip_source_dest_check': :'skipSourceDestCheck',
    'subnet_id': :'subnetId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'assign_ipv6_ip': :'BOOLEAN',
    'assign_public_ip': :'BOOLEAN',
    'assign_private_dns_record': :'BOOLEAN',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'ipv6_address_ipv6_subnet_cidr_pair_details': :'Array<OCI::Core::Models::InstanceConfigurationIpv6AddressIpv6SubnetCidrPairDetails>',
    'hostname_label': :'String',
    'nsg_ids': :'Array<String>',
    'subnet_cidr': :'String',
    'private_ip': :'String',
    'private_ip_id': :'String',
    'skip_source_dest_check': :'BOOLEAN',
    'subnet_id': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 294

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    assign_ipv6_ip == other.assign_ipv6_ip &&
    assign_public_ip == other.assign_public_ip &&
    assign_private_dns_record == other.assign_private_dns_record &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    security_attributes == other.security_attributes &&
    ipv6_address_ipv6_subnet_cidr_pair_details == other.ipv6_address_ipv6_subnet_cidr_pair_details &&
    hostname_label == other.hostname_label &&
    nsg_ids == other.nsg_ids &&
    subnet_cidr == other.subnet_cidr &&
    private_ip == other.private_ip &&
    private_ip_id == other.private_ip_id &&
    skip_source_dest_check == other.skip_source_dest_check &&
    subnet_id == other.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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 338

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


318
319
320
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 318

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



327
328
329
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 327

def hash
  [assign_ipv6_ip, assign_public_ip, assign_private_dns_record, defined_tags, display_name, freeform_tags, security_attributes, ipv6_address_ipv6_subnet_cidr_pair_details, hostname_label, nsg_ids, subnet_cidr, private_ip, private_ip_id, 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



371
372
373
374
375
376
377
378
379
380
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 371

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



365
366
367
 
# File 'lib/oci/core/models/instance_configuration_create_vnic_details.rb', line 365

def to_s
  to_hash.to_s
end