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

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
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
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 84

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[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end
  
  if attributes[:'routeTableId']
    self.route_table_id = attributes[:'routeTableId']
  end
  
  if attributes[:'securityListIds']
    self.security_list_ids = attributes[:'securityListIds']
  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) 


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

def availability_domain
  @availability_domain
end

#cidr_block ⇒ String

The subnet’s CIDR block.

Example: ‘172.16.1.0/24`

Returns:

  • (String) 


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

def cidr_block
  @cidr_block
end

#compartment_id ⇒ String

The OCID of the compartment containing the subnet.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#dhcp_options_id ⇒ String

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

Returns:

  • (String) 


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

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) 


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

def display_name
  @display_name
end

#id ⇒ String

The subnet’s Oracle ID (OCID).

Returns:

  • (String) 


42
43
44
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 42

def id
  @id
end

#lifecycle_state ⇒ String

The subnet’s current state.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 46

def lifecycle_state
  @lifecycle_state
end

#route_table_id ⇒ String

The OCID of the route table the subnet is using.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 50

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


54
55
56
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 54

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


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

def time_created
  @time_created
end

#vcn_id ⇒ String

The OCID of the VCN the subnet is in.

Returns:

  • (String) 


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

def vcn_id
  @vcn_id
end

#virtual_router_ip ⇒ String

The IP address of the virtual router.

Example: ‘10.0.14.1`

Returns:

  • (String) 


72
73
74
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 72

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) 


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

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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 156

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 &&
      id == other_object.id &&
      lifecycle_state == other_object.lifecycle_state &&
      route_table_id == other_object.route_table_id &&
      security_list_ids == other_object.security_list_ids &&
      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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 189

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


176
177
178
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 176

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



182
183
184
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 182

def hash
  [availability_domain, cidr_block, compartment_id, dhcp_options_id, display_name, id, lifecycle_state, route_table_id, security_list_ids, 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



214
215
216
217
218
219
220
221
222
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 214

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



208
209
210
 
# File 'lib/oraclebmc/core/models/subnet.rb', line 208

def to_s
  to_hash.to_s
end