Class: OCI::Core::Models::LocalPeeringGateway
- Inherits:
-
Object
- Object
- OCI::Core::Models::LocalPeeringGateway
- Defined in:
- lib/oci/core/models/local_peering_gateway.rb
Overview
A local peering gateway (LPG) is an object on a VCN that lets that VCN peer with another VCN in the same region. Peering means that the two VCNs can communicate using private IP addresses, but without the traffic traversing the internet or routing through your on-premises network. For more information, see VCN Peering.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're 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
- PEERING_STATUS_ENUM =
[ PEERING_STATUS_INVALID = 'INVALID'.freeze, PEERING_STATUS_NEW = 'NEW'.freeze, PEERING_STATUS_PEERED = 'PEERED'.freeze, PEERING_STATUS_PENDING = 'PENDING'.freeze, PEERING_STATUS_REVOKED = 'REVOKED'.freeze, PEERING_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the LPG.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] A user-friendly name.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The LPG's Oracle ID (OCID).
-
#is_cross_tenancy_peering ⇒ BOOLEAN
[Required] Whether the VCN at the other end of the peering is in a different tenancy.
-
#lifecycle_state ⇒ String
[Required] The LPG's current lifecycle state.
-
#peer_advertised_cidr ⇒ String
The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG.
-
#peer_advertised_cidr_details ⇒ Array<String>
The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG.
-
#peer_id ⇒ String
[Required] The OCID of the peered LPG.
-
#peering_status ⇒ String
[Required] Whether the LPG is peered with another LPG.
-
#peering_status_details ⇒ String
Additional information regarding the peering status, if applicable.
-
#route_table_id ⇒ String
The OCID of the route table the LPG is using.
-
#time_created ⇒ DateTime
[Required] The date and time the LPG was created, in the format defined by RFC3339.
-
#vcn_id ⇒ String
[Required] The OCID of the VCN that uses the LPG.
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 = {}) ⇒ LocalPeeringGateway
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 = {}) ⇒ LocalPeeringGateway
Initializes the object
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 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 199 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.is_cross_tenancy_peering = attributes[:'isCrossTenancyPeering'] unless attributes[:'isCrossTenancyPeering'].nil? raise 'You cannot provide both :isCrossTenancyPeering and :is_cross_tenancy_peering' if attributes.key?(:'isCrossTenancyPeering') && attributes.key?(:'is_cross_tenancy_peering') self.is_cross_tenancy_peering = attributes[:'is_cross_tenancy_peering'] unless attributes[:'is_cross_tenancy_peering'].nil? 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.peer_advertised_cidr = attributes[:'peerAdvertisedCidr'] if attributes[:'peerAdvertisedCidr'] raise 'You cannot provide both :peerAdvertisedCidr and :peer_advertised_cidr' if attributes.key?(:'peerAdvertisedCidr') && attributes.key?(:'peer_advertised_cidr') self.peer_advertised_cidr = attributes[:'peer_advertised_cidr'] if attributes[:'peer_advertised_cidr'] self.peer_advertised_cidr_details = attributes[:'peerAdvertisedCidrDetails'] if attributes[:'peerAdvertisedCidrDetails'] raise 'You cannot provide both :peerAdvertisedCidrDetails and :peer_advertised_cidr_details' if attributes.key?(:'peerAdvertisedCidrDetails') && attributes.key?(:'peer_advertised_cidr_details') self.peer_advertised_cidr_details = attributes[:'peer_advertised_cidr_details'] if attributes[:'peer_advertised_cidr_details'] self.peering_status = attributes[:'peeringStatus'] if attributes[:'peeringStatus'] raise 'You cannot provide both :peeringStatus and :peering_status' if attributes.key?(:'peeringStatus') && attributes.key?(:'peering_status') self.peering_status = attributes[:'peering_status'] if attributes[:'peering_status'] self.peering_status_details = attributes[:'peeringStatusDetails'] if attributes[:'peeringStatusDetails'] raise 'You cannot provide both :peeringStatusDetails and :peering_status_details' if attributes.key?(:'peeringStatusDetails') && attributes.key?(:'peering_status_details') self.peering_status_details = attributes[:'peering_status_details'] if attributes[:'peering_status_details'] self.peer_id = attributes[:'peerId'] if attributes[:'peerId'] raise 'You cannot provide both :peerId and :peer_id' if attributes.key?(:'peerId') && attributes.key?(:'peer_id') self.peer_id = attributes[:'peer_id'] if attributes[:'peer_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'] 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'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the LPG.
40 41 42 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 40 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. For more information, see Resource Tags.
Example: {\"Operations\": {\"CostCenter\": \"42\"}}
48 49 50 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 48 def @defined_tags end |
#display_name ⇒ String
[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
54 55 56 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 54 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\"}
62 63 64 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 62 def @freeform_tags end |
#id ⇒ String
[Required] The LPG's Oracle ID (OCID).
66 67 68 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 66 def id @id end |
#is_cross_tenancy_peering ⇒ BOOLEAN
[Required] Whether the VCN at the other end of the peering is in a different tenancy.
Example: false
73 74 75 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 73 def is_cross_tenancy_peering @is_cross_tenancy_peering end |
#lifecycle_state ⇒ String
[Required] The LPG's current lifecycle state.
77 78 79 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 77 def lifecycle_state @lifecycle_state end |
#peer_advertised_cidr ⇒ String
The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG. See peerAdvertisedCidrDetails
for the individual CIDRs. The value is null
if the LPG is not peered.
Example: 192.168.0.0/16
, or if aggregated with 172.16.0.0/24
then 128.0.0.0/1
86 87 88 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 86 def peer_advertised_cidr @peer_advertised_cidr end |
#peer_advertised_cidr_details ⇒ Array<String>
The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG. The value is null
if the LPG is not peered. You can use these as destination CIDRs for route rules to route a subnet's traffic to this LPG.
Example: [192.168.0.0/16
, 172.16.0.0/24
]
96 97 98 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 96 def peer_advertised_cidr_details @peer_advertised_cidr_details end |
#peer_id ⇒ String
[Required] The OCID of the peered LPG.
111 112 113 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 111 def peer_id @peer_id end |
#peering_status ⇒ String
[Required] Whether the LPG is peered with another LPG. NEW
means the LPG has not yet been peered. PENDING
means the peering is being established. REVOKED
means the LPG at the other end of the peering has been deleted.
103 104 105 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 103 def peering_status @peering_status end |
#peering_status_details ⇒ String
Additional information regarding the peering status, if applicable.
107 108 109 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 107 def peering_status_details @peering_status_details end |
#route_table_id ⇒ String
The OCID of the route table the LPG is using.
For information about why you would associate a route table with an LPG, see Transit Routing: Access to Multiple VCNs in Same Region.
119 120 121 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 119 def route_table_id @route_table_id end |
#time_created ⇒ DateTime
[Required] The date and time the LPG was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
126 127 128 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 126 def time_created @time_created end |
#vcn_id ⇒ String
[Required] The OCID of the VCN that uses the LPG.
130 131 132 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 130 def vcn_id @vcn_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 133 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'defined_tags': :'definedTags', 'display_name': :'displayName', 'freeform_tags': :'freeformTags', 'id': :'id', 'is_cross_tenancy_peering': :'isCrossTenancyPeering', 'lifecycle_state': :'lifecycleState', 'peer_advertised_cidr': :'peerAdvertisedCidr', 'peer_advertised_cidr_details': :'peerAdvertisedCidrDetails', 'peering_status': :'peeringStatus', 'peering_status_details': :'peeringStatusDetails', 'peer_id': :'peerId', 'route_table_id': :'routeTableId', 'time_created': :'timeCreated', 'vcn_id': :'vcnId' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 156 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', 'is_cross_tenancy_peering': :'BOOLEAN', 'lifecycle_state': :'String', 'peer_advertised_cidr': :'String', 'peer_advertised_cidr_details': :'Array<String>', 'peering_status': :'String', 'peering_status_details': :'String', 'peer_id': :'String', 'route_table_id': :'String', 'time_created': :'DateTime', 'vcn_id': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 325 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 && is_cross_tenancy_peering == other.is_cross_tenancy_peering && lifecycle_state == other.lifecycle_state && peer_advertised_cidr == other.peer_advertised_cidr && peer_advertised_cidr_details == other.peer_advertised_cidr_details && peering_status == other.peering_status && peering_status_details == other.peering_status_details && peer_id == other.peer_id && route_table_id == other.route_table_id && time_created == other.time_created && vcn_id == other.vcn_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 369 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
349 350 351 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 349 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
358 359 360 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 358 def hash [compartment_id, , display_name, , id, is_cross_tenancy_peering, lifecycle_state, peer_advertised_cidr, peer_advertised_cidr_details, peering_status, peering_status_details, peer_id, route_table_id, time_created, vcn_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
402 403 404 405 406 407 408 409 410 411 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 402 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
396 397 398 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 396 def to_s to_hash.to_s end |