Class: OracleBMC::Core::Models::Subnet

Inherits:
Object
  • Object
show all
Defined in:
lib/oraclebmc/core/models/subnet.rb

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE',
LIFECYCLE_STATE_TERMINATING = 'TERMINATING',
LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Subnet

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 127

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[:'availabilityDomain']
    self.availability_domain = attributes[:'availabilityDomain']
  end
  
  if attributes[:'cidrBlock']
    self.cidr_block = attributes[:'cidrBlock']
  end
  
  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end
  
  if attributes[:'dhcpOptionsId']
    self.dhcp_options_id = attributes[:'dhcpOptionsId']
  end
  
  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end
  
  if attributes[:'dnsLabel']
    self.dns_label = attributes[:'dnsLabel']
  end
  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end
  
  if attributes[:'prohibitPublicIpOnVnic']
    self.prohibit_public_ip_on_vnic = attributes[:'prohibitPublicIpOnVnic']
  end
  
  if attributes[:'routeTableId']
    self.route_table_id = attributes[:'routeTableId']
  end
  
  if attributes[:'securityListIds']
    self.security_list_ids = attributes[:'securityListIds']
  end
  
  if attributes[:'subnetDomainName']
    self.subnet_domain_name = attributes[:'subnetDomainName']
  end
  
  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end
  
  if attributes[:'vcnId']
    self.vcn_id = attributes[:'vcnId']
  end
  
  if attributes[:'virtualRouterIp']
    self.virtual_router_ip = attributes[:'virtualRouterIp']
  end
  
  if attributes[:'virtualRouterMac']
    self.virtual_router_mac = attributes[:'virtualRouterMac']
  end
  
end

Instance Attribute Details

#availability_domain ⇒ String

The subnet’s Availability Domain.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


19
20
21
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 19

def availability_domain
  @availability_domain
end

#cidr_block ⇒ String

The subnet’s CIDR block.

Example: ‘172.16.1.0/24`

Returns:

  • (String) 


26
27
28
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 26

def cidr_block
  @cidr_block
end

#compartment_id ⇒ String

The OCID of the compartment containing the subnet.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 30

def compartment_id
  @compartment_id
end

#dhcp_options_id ⇒ String

The OCID of the set of DHCP options associated with the subnet.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 35

def dhcp_options_id
  @dhcp_options_id
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it’s changeable.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 39

def display_name
  @display_name
end

#dns_label ⇒ String

A DNS label for the subnet, used in conjunction with the VNIC’s hostname and VCN’s DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (e.g., ‘bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed.

The absence of this parameter means the Internet and VCN Resolver will not resolve hostnames of instances in this subnet.

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

Example: ‘subnet123`

Returns:

  • (String) 


56
57
58
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 56

def dns_label
  @dns_label
end

#id ⇒ String

The subnet’s Oracle ID (OCID).

Returns:

  • (String) 


60
61
62
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 60

def id
  @id
end

#lifecycle_state ⇒ String

The subnet’s current state.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 64

def lifecycle_state
  @lifecycle_state
end

#prohibit_public_ip_on_vnic ⇒ BOOLEAN

Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch (with the ‘assignPublicIp` flag in CreateVnicDetails). If `prohibitPublicIpOnVnic` is set to true, VNICs created in this subnet cannot have public IP addresses (i.e., it’s a private subnet).

Example: ‘true`

Returns:

  • (BOOLEAN) 


78
79
80
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 78

def prohibit_public_ip_on_vnic
  @prohibit_public_ip_on_vnic
end

#route_table_id ⇒ String

The OCID of the route table the subnet is using.

Returns:

  • (String) 


82
83
84
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 82

def route_table_id
  @route_table_id
end

#security_list_ids ⇒ Array<String>

OCIDs for the security lists to use for VNICs in this subnet.

Returns:

  • (Array<String>) 


86
87
88
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 86

def security_list_ids
  @security_list_ids
end

#subnet_domain_name ⇒ String

The subnet’s domain name, which consists of the subnet’s DNS label, the VCN’s DNS label, and the ‘oraclevcn.com` domain.

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

Example: ‘subnet123.vcn1.oraclevcn.com`

Returns:

  • (String) 


97
98
99
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 97

def subnet_domain_name
  @subnet_domain_name
end

#time_created ⇒ DateTime

The date and time the subnet was created, in the format defined by RFC3339.

Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


104
105
106
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 104

def time_created
  @time_created
end

#vcn_id ⇒ String

The OCID of the VCN the subnet is in.

Returns:

  • (String) 


108
109
110
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 108

def vcn_id
  @vcn_id
end

#virtual_router_ip ⇒ String

The IP address of the virtual router.

Example: ‘10.0.14.1`

Returns:

  • (String) 


115
116
117
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 115

def virtual_router_ip
  @virtual_router_ip
end

#virtual_router_mac ⇒ String

The MAC address of the virtual router.

Example: ‘00:00:17:B6:4D:DD`

Returns:

  • (String) 


122
123
124
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 122

def virtual_router_mac
  @virtual_router_mac
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 212

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      availability_domain == other_object.availability_domain &&
      cidr_block == other_object.cidr_block &&
      compartment_id == other_object.compartment_id &&
      dhcp_options_id == other_object.dhcp_options_id &&
      display_name == other_object.display_name &&
      dns_label == other_object.dns_label &&
      id == other_object.id &&
      lifecycle_state == other_object.lifecycle_state &&
      prohibit_public_ip_on_vnic == other_object.prohibit_public_ip_on_vnic &&
      route_table_id == other_object.route_table_id &&
      security_list_ids == other_object.security_list_ids &&
      subnet_domain_name == other_object.subnet_domain_name &&
      time_created == other_object.time_created &&
      vcn_id == other_object.vcn_id &&
      virtual_router_ip == other_object.virtual_router_ip &&
      virtual_router_mac == other_object.virtual_router_mac
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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 248

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.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| OracleBMC::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", OracleBMC::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


235
236
237
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 235

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



241
242
243
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 241

def hash
  [availability_domain, cidr_block, compartment_id, dhcp_options_id, display_name, dns_label, id, lifecycle_state, prohibit_public_ip_on_vnic, route_table_id, security_list_ids, subnet_domain_name, time_created, vcn_id, virtual_router_ip, virtual_router_mac].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



273
274
275
276
277
278
279
280
281
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 273

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



267
268
269
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 267

def to_s
  to_hash.to_s
end