Class: OCI::Core::Models::CreatePrivateIpDetails

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

Overview

CreatePrivateIpDetails model.

Constant Summary collapse

LIFETIME_ENUM = 
[
  LIFETIME_EPHEMERAL = 'EPHEMERAL'.freeze,
  LIFETIME_RESERVED = 'RESERVED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePrivateIpDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :hostname_label (String) —

    The value to assign to the #hostname_label property

  • :ip_address (String) —

    The value to assign to the #ip_address property

  • :cidr_prefix_length (Integer) —

    The value to assign to the #cidr_prefix_length property

  • :vnic_id (String) —

    The value to assign to the #vnic_id property

  • :vlan_id (String) —

    The value to assign to the #vlan_id property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :ipv4_subnet_cidr_at_creation (String) —

    The value to assign to the #ipv4_subnet_cidr_at_creation property

  • :lifetime (String) —

    The value to assign to the #lifetime property

  • :route_table_id (String) —

    The value to assign to the #route_table_id property



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

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

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

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

  self.cidr_prefix_length = attributes[:'cidrPrefixLength'] if attributes[:'cidrPrefixLength']

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

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

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

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

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

  self.vlan_id = attributes[:'vlanId'] if attributes[:'vlanId']

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

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

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

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

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

  self.lifetime = attributes[:'lifetime'] if attributes[:'lifetime']
  self.lifetime = "EPHEMERAL" if lifetime.nil? && !attributes.key?(:'lifetime') # rubocop:disable Style/StringLiterals

  self.route_table_id = attributes[:'routeTableId'] if attributes[:'routeTableId']

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

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

Instance Attribute Details

#cidr_prefix_length ⇒ Integer

An optional field that when combined with the ipAddress field, will be used to allocate secondary IPv4 CIDRs. The CIDR range created by this combination must be within the subnet's CIDR and the CIDR range should not collide with any existing IPv4 address allocation. The VNIC ID specified in the request object should not already been assigned more than the max IPv4 addresses. If you don't specify a value, this option will be ignored.

Example: 18

Returns:

  • (Integer) 


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

def cidr_prefix_length
  @cidr_prefix_length
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>>) 


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

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) 


28
29
30
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 28

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


36
37
38
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 36

def freeform_tags
  @freeform_tags
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, bminstance1 in FQDN bminstance1.subnet123.vcn1.oraclevcn.com). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.

For more information, see DNS in Your Virtual Cloud Network.

Example: bminstance1

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 51

def hostname_label
  @hostname_label
end

#ip_address ⇒ String

A private IP address of your choice. 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.

Example: 10.0.3.3

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 60

def ip_address
  @ip_address
end

#ipv4_subnet_cidr_at_creation ⇒ String

Any one of the IPv4 CIDRs allocated to the subnet.

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 96

def ipv4_subnet_cidr_at_creation
  @ipv4_subnet_cidr_at_creation
end

#lifetime ⇒ String

Lifetime of the IP address. There are two types of IPs: - Ephemeral - Reserved

Returns:

  • (String) 


104
105
106
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 104

def lifetime
  @lifetime
end

#route_table_id ⇒ String

The OCID of the route table the IP address or VNIC will use. For more information, see Per-resource Routing.

Returns:

  • (String) 


110
111
112
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 110

def route_table_id
  @route_table_id
end

#subnet_id ⇒ String

The OCID of the subnet from which the private IP is to be drawn. The IP address, if supplied, must be valid for the given subnet.

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 91

def subnet_id
  @subnet_id
end

#vlan_id ⇒ String

Use this attribute only with the Oracle Cloud VMware Solution.

The OCID of the VLAN from which the private IP is to be drawn. The IP address, if supplied, must be valid for the given VLAN. See Vlan.

Returns:

  • (String) 


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

def vlan_id
  @vlan_id
end

#vnic_id ⇒ String

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

Returns:

  • (String) 


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

def vnic_id
  @vnic_id
end

Class Method Details

.attribute_map ⇒ Object

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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 113

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'hostname_label': :'hostnameLabel',
    'ip_address': :'ipAddress',
    'cidr_prefix_length': :'cidrPrefixLength',
    'vnic_id': :'vnicId',
    'vlan_id': :'vlanId',
    'subnet_id': :'subnetId',
    'ipv4_subnet_cidr_at_creation': :'ipv4SubnetCidrAtCreation',
    'lifetime': :'lifetime',
    'route_table_id': :'routeTableId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 133

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'hostname_label': :'String',
    'ip_address': :'String',
    'cidr_prefix_length': :'Integer',
    'vnic_id': :'String',
    'vlan_id': :'String',
    'subnet_id': :'String',
    'ipv4_subnet_cidr_at_creation': :'String',
    'lifetime': :'String',
    'route_table_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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 261

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

  self.class == other.class &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    hostname_label == other.hostname_label &&
    ip_address == other.ip_address &&
    cidr_prefix_length == other.cidr_prefix_length &&
    vnic_id == other.vnic_id &&
    vlan_id == other.vlan_id &&
    subnet_id == other.subnet_id &&
    ipv4_subnet_cidr_at_creation == other.ipv4_subnet_cidr_at_creation &&
    lifetime == other.lifetime &&
    route_table_id == other.route_table_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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 302

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


282
283
284
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 282

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



291
292
293
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 291

def hash
  [defined_tags, display_name, freeform_tags, hostname_label, ip_address, cidr_prefix_length, vnic_id, vlan_id, subnet_id, ipv4_subnet_cidr_at_creation, lifetime, route_table_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



335
336
337
338
339
340
341
342
343
344
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 335

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



329
330
331
 
# File 'lib/oci/core/models/create_private_ip_details.rb', line 329

def to_s
  to_hash.to_s
end