Class: OCI::VnMonitoring::Models::NatGateway
- Inherits:
-
Object
- Object
- OCI::VnMonitoring::Models::NatGateway
- Defined in:
- lib/oci/vn_monitoring/models/nat_gateway.rb
Overview
A NAT (Network Address Translation) gateway, which represents a router that lets instances without public IPs contact the public internet without exposing the instance to inbound internet traffic. For more information, see NAT Gateway.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze, LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze, LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze, LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#block_traffic ⇒ BOOLEAN
[Required] Whether the NAT gateway blocks traffic through it.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the NAT gateway.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
A user-friendly name.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] The OCID of the NAT gateway.
-
#lifecycle_state ⇒ String
[Required] The NAT gateway's current state.
-
#nat_ip ⇒ String
[Required] The IP address associated with the NAT gateway.
-
#public_ip_id ⇒ String
The OCID of the public IP address associated with the NAT gateway.
-
#route_table_id ⇒ String
The OCID of the route table used by the NAT gateway.
-
#time_created ⇒ DateTime
[Required] The date and time the NAT gateway was created, in the format defined by RFC3339.
-
#vcn_id ⇒ String
[Required] The OCID of the VCN the NAT gateway belongs to.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ NatGateway
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ NatGateway
Initializes the object
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 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 161 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.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = 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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self.id = attributes[:'id'] if attributes[:'id'] self.block_traffic = attributes[:'blockTraffic'] unless attributes[:'blockTraffic'].nil? self.block_traffic = false if block_traffic.nil? && !attributes.key?(:'blockTraffic') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :blockTraffic and :block_traffic' if attributes.key?(:'blockTraffic') && attributes.key?(:'block_traffic') self.block_traffic = attributes[:'block_traffic'] unless attributes[:'block_traffic'].nil? self.block_traffic = false if block_traffic.nil? && !attributes.key?(:'blockTraffic') && !attributes.key?(:'block_traffic') # rubocop:disable Style/StringLiterals self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.nat_ip = attributes[:'natIp'] if attributes[:'natIp'] raise 'You cannot provide both :natIp and :nat_ip' if attributes.key?(:'natIp') && attributes.key?(:'nat_ip') self.nat_ip = attributes[:'nat_ip'] if attributes[:'nat_ip'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.vcn_id = attributes[:'vcnId'] if attributes[:'vcnId'] raise 'You cannot provide both :vcnId and :vcn_id' if attributes.key?(:'vcnId') && attributes.key?(:'vcn_id') self.vcn_id = attributes[:'vcn_id'] if attributes[:'vcn_id'] self.public_ip_id = attributes[:'publicIpId'] if attributes[:'publicIpId'] raise 'You cannot provide both :publicIpId and :public_ip_id' if attributes.key?(:'publicIpId') && attributes.key?(:'public_ip_id') self.public_ip_id = attributes[:'public_ip_id'] if attributes[:'public_ip_id'] 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
#block_traffic ⇒ BOOLEAN
[Required] Whether the NAT gateway blocks traffic through it. The default is false
.
Example: true
65 66 67 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 65 def block_traffic @block_traffic end |
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the NAT gateway.
34 35 36 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 34 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
40 41 42 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 40 def @defined_tags end |
#display_name ⇒ String
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
46 47 48 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 46 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}
52 53 54 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 52 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the NAT gateway.
58 59 60 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 58 def id @id end |
#lifecycle_state ⇒ String
[Required] The NAT gateway's current state.
69 70 71 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 69 def lifecycle_state @lifecycle_state end |
#nat_ip ⇒ String
[Required] The IP address associated with the NAT gateway.
74 75 76 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 74 def nat_ip @nat_ip end |
#public_ip_id ⇒ String
The OCID of the public IP address associated with the NAT gateway.
92 93 94 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 92 def public_ip_id @public_ip_id end |
#route_table_id ⇒ String
The OCID of the route table used by the NAT gateway.
If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.
101 102 103 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 101 def route_table_id @route_table_id end |
#time_created ⇒ DateTime
[Required] The date and time the NAT gateway was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
81 82 83 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 81 def time_created @time_created end |
#vcn_id ⇒ String
[Required] The OCID of the VCN the NAT gateway belongs to.
87 88 89 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 87 def vcn_id @vcn_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 104 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'defined_tags': :'definedTags', 'display_name': :'displayName', 'freeform_tags': :'freeformTags', 'id': :'id', 'block_traffic': :'blockTraffic', 'lifecycle_state': :'lifecycleState', 'nat_ip': :'natIp', 'time_created': :'timeCreated', 'vcn_id': :'vcnId', 'public_ip_id': :'publicIpId', 'route_table_id': :'routeTableId' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 124 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'display_name': :'String', 'freeform_tags': :'Hash<String, String>', 'id': :'String', 'block_traffic': :'BOOLEAN', 'lifecycle_state': :'String', 'nat_ip': :'String', 'time_created': :'DateTime', 'vcn_id': :'String', 'public_ip_id': :'String', 'route_table_id': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 258 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && == other. && display_name == other.display_name && == other. && id == other.id && block_traffic == other.block_traffic && lifecycle_state == other.lifecycle_state && nat_ip == other.nat_ip && time_created == other.time_created && vcn_id == other.vcn_id && public_ip_id == other.public_ip_id && route_table_id == other.route_table_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 299 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
279 280 281 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 279 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
288 289 290 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 288 def hash [compartment_id, , display_name, , id, block_traffic, lifecycle_state, nat_ip, time_created, vcn_id, public_ip_id, route_table_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
332 333 334 335 336 337 338 339 340 341 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 332 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
326 327 328 |
# File 'lib/oci/vn_monitoring/models/nat_gateway.rb', line 326 def to_s to_hash.to_s end |