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](docs.cloud.oracle.com/Content/Network/Tasks/VCNpeering.htm).
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](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
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.
-
#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 the LPG 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 = {}) ⇒ 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
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 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 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 192 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.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.
41 42 43 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 41 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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
Example: ‘{"CostCenter": "42"}`
49 50 51 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 49 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.
55 56 57 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 55 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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
Example: ‘"Finance"`
63 64 65 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 63 def @freeform_tags end |
#id ⇒ String
[Required] The LPG’s Oracle ID (OCID).
67 68 69 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 67 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`
74 75 76 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 74 def is_cross_tenancy_peering @is_cross_tenancy_peering end |
#lifecycle_state ⇒ String
[Required] The LPG’s current lifecycle state.
78 79 80 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 78 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`
87 88 89 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 87 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`]
97 98 99 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 97 def peer_advertised_cidr_details @peer_advertised_cidr_details 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.
104 105 106 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 104 def peering_status @peering_status end |
#peering_status_details ⇒ String
Additional information regarding the peering status, if applicable.
108 109 110 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 108 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 [Advanced Scenario: Transit Routing](docs.cloud.oracle.com/Content/Network/Tasks/transitrouting.htm).
115 116 117 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 115 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`
122 123 124 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 122 def time_created @time_created end |
#vcn_id ⇒ String
[Required] The OCID of the VCN the LPG belongs to.
126 127 128 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 126 def vcn_id @vcn_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 129 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', 'route_table_id': :'routeTableId', 'time_created': :'timeCreated', 'vcn_id': :'vcnId' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 151 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', '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.
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 312 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 && 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
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 355 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
335 336 337 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 335 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
344 345 346 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 344 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, route_table_id, time_created, vcn_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
388 389 390 391 392 393 394 395 396 397 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 388 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
382 383 384 |
# File 'lib/oci/core/models/local_peering_gateway.rb', line 382 def to_s to_hash.to_s end |