Class: OCI::ContainerEngine::Models::CreateVnicDetails

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

Overview

The properties of the secondary vnics

Instance Attribute Summary collapse

Class Method 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

Options Hash (attributes):



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
180
181
182
183
184
185
186
187
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
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 135

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.assign_ipv6_ip = attributes[:'assignIpv6Ip'] unless attributes[:'assignIpv6Ip'].nil?

  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_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.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.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.ip_count = attributes[:'ipCount'] if attributes[:'ipCount']

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

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

  self.application_resources = attributes[:'applicationResources'] if attributes[:'applicationResources']

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

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

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

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

Instance Attribute Details

#application_resources ⇒ Array<String>

The application resource that corresponds to this secondary vnic. Used to map pods to this specific vnic for scheduling

Returns:

  • (Array<String>) 


47
48
49
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 47

def application_resources
  @application_resources
end

#assign_ipv6_ip ⇒ BOOLEAN

Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet

Returns:

  • (BOOLEAN) 


18
19
20
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 18

def assign_ipv6_ip
  @assign_ipv6_ip
end

#assign_public_ip ⇒ BOOLEAN

Whether the VNIC should be assigned a public IP address

Returns:

  • (BOOLEAN) 


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

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>>) 


30
31
32
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 30

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Display name for secondary vnic

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 13

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>) 


37
38
39
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 37

def freeform_tags
  @freeform_tags
end

#ip_count ⇒ Integer

The number of ip addresses to attach to secondary vnic

Returns:

  • (Integer) 


42
43
44
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 42

def ip_count
  @ip_count
end

#ipv6_address_ipv6_subnet_cidr_pair_details ⇒ Array<OCI::ContainerEngine::Models::Ipv6AddressIpv6SubnetCidrPairDetails>

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:



54
55
56
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 54

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

Returns:

  • (Array<String>) 


59
60
61
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 59

def nsg_ids
  @nsg_ids
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.

Returns:

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


75
76
77
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 75

def security_attributes
  @security_attributes
end

#skip_source_dest_check ⇒ BOOLEAN

Whether the source/destination check is disabled on the VNIC

Returns:

  • (BOOLEAN) 


64
65
66
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 64

def skip_source_dest_check
  @skip_source_dest_check
end

#subnet_id ⇒ String

[Required] the ocid of the subnet to create the vnic in

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 68

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 78

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'assign_ipv6_ip': :'assignIpv6Ip',
    'assign_public_ip': :'assignPublicIp',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'ip_count': :'ipCount',
    'application_resources': :'applicationResources',
    'ipv6_address_ipv6_subnet_cidr_pair_details': :'ipv6AddressIpv6SubnetCidrPairDetails',
    'nsg_ids': :'nsgIds',
    'skip_source_dest_check': :'skipSourceDestCheck',
    'subnet_id': :'subnetId',
    'security_attributes': :'securityAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 98

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'assign_ipv6_ip': :'BOOLEAN',
    'assign_public_ip': :'BOOLEAN',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'ip_count': :'Integer',
    'application_resources': :'Array<String>',
    'ipv6_address_ipv6_subnet_cidr_pair_details': :'Array<OCI::ContainerEngine::Models::Ipv6AddressIpv6SubnetCidrPairDetails>',
    'nsg_ids': :'Array<String>',
    'skip_source_dest_check': :'BOOLEAN',
    'subnet_id': :'String',
    'security_attributes': :'Hash<String, Hash<String, Object>>'
    # 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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 221

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

  self.class == other.class &&
    display_name == other.display_name &&
    assign_ipv6_ip == other.assign_ipv6_ip &&
    assign_public_ip == other.assign_public_ip &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    ip_count == other.ip_count &&
    application_resources == other.application_resources &&
    ipv6_address_ipv6_subnet_cidr_pair_details == other.ipv6_address_ipv6_subnet_cidr_pair_details &&
    nsg_ids == other.nsg_ids &&
    skip_source_dest_check == other.skip_source_dest_check &&
    subnet_id == other.subnet_id &&
    security_attributes == other.security_attributes
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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 262

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


242
243
244
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 242

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



251
252
253
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 251

def hash
  [display_name, assign_ipv6_ip, assign_public_ip, defined_tags, freeform_tags, ip_count, application_resources, ipv6_address_ipv6_subnet_cidr_pair_details, nsg_ids, skip_source_dest_check, subnet_id, security_attributes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



295
296
297
298
299
300
301
302
303
304
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 295

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



289
290
291
 
# File 'lib/oci/container_engine/models/create_vnic_details.rb', line 289

def to_s
  to_hash.to_s
end