Class: OCI::Core::Models::RemotePeeringConnection
- Inherits:
-
Object
- Object
- OCI::Core::Models::RemotePeeringConnection
- Defined in:
- lib/oci/core/models/remote_peering_connection.rb
Overview
A remote peering connection (RPC) is an object on a DRG that lets the VCN that is attached to the DRG peer with a VCN in a different 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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
rubocop:disable Metrics/LineLength
[ LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze, LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.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_PENDING = 'PENDING'.freeze, PEERING_STATUS_PEERED = 'PEERED'.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 that contains the RPC.
-
#display_name ⇒ String
[Required] A user-friendly name.
-
#drg_id ⇒ String
[Required] The OCID of the DRG that this RPC belongs to.
-
#id ⇒ String
[Required] The OCID of the RPC.
-
#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 RPC’s current lifecycle state.
-
#peer_id ⇒ String
If this RPC is peered, this value is the OCID of the other RPC.
-
#peer_region_name ⇒ String
If this RPC is peered, this value is the region that contains the other RPC.
-
#peer_tenancy_id ⇒ String
If this RPC is peered, this value is the OCID of the other RPC’s tenancy.
-
#peering_status ⇒ String
[Required] Whether the RPC is peered with another RPC.
-
#time_created ⇒ DateTime
[Required] The date and time the RPC was created, in the format defined by RFC3339.
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 = {}) ⇒ RemotePeeringConnection
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 = {}) ⇒ RemotePeeringConnection
Initializes the object
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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 151 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.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.drg_id = attributes[:'drgId'] if attributes[:'drgId'] raise 'You cannot provide both :drgId and :drg_id' if attributes.key?(:'drgId') && attributes.key?(:'drg_id') self.drg_id = attributes[:'drg_id'] if attributes[:'drg_id'] 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_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.peer_region_name = attributes[:'peerRegionName'] if attributes[:'peerRegionName'] raise 'You cannot provide both :peerRegionName and :peer_region_name' if attributes.key?(:'peerRegionName') && attributes.key?(:'peer_region_name') self.peer_region_name = attributes[:'peer_region_name'] if attributes[:'peer_region_name'] self.peer_tenancy_id = attributes[:'peerTenancyId'] if attributes[:'peerTenancyId'] raise 'You cannot provide both :peerTenancyId and :peer_tenancy_id' if attributes.key?(:'peerTenancyId') && attributes.key?(:'peer_tenancy_id') self.peer_tenancy_id = attributes[:'peer_tenancy_id'] if attributes[:'peer_tenancy_id'] 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.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'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the RPC.
38 39 40 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 38 def compartment_id @compartment_id end |
#display_name ⇒ String
[Required] A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
44 45 46 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 44 def display_name @display_name end |
#drg_id ⇒ String
[Required] The OCID of the DRG that this RPC belongs to.
48 49 50 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 48 def drg_id @drg_id end |
#id ⇒ String
[Required] The OCID of the RPC.
52 53 54 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 52 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`
59 60 61 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 59 def is_cross_tenancy_peering @is_cross_tenancy_peering end |
#lifecycle_state ⇒ String
[Required] The RPC’s current lifecycle state.
63 64 65 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 63 def lifecycle_state @lifecycle_state end |
#peer_id ⇒ String
If this RPC is peered, this value is the OCID of the other RPC.
68 69 70 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 68 def peer_id @peer_id end |
#peer_region_name ⇒ String
If this RPC is peered, this value is the region that contains the other RPC.
Example: ‘us-ashburn-1`
75 76 77 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 75 def peer_region_name @peer_region_name end |
#peer_tenancy_id ⇒ String
If this RPC is peered, this value is the OCID of the other RPC’s tenancy.
80 81 82 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 80 def peer_tenancy_id @peer_tenancy_id end |
#peering_status ⇒ String
[Required] Whether the RPC is peered with another RPC. ‘NEW` means the RPC has not yet been peered. `PENDING` means the peering is being established. `REVOKED` means the RPC at the other end of the peering has been deleted.
87 88 89 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 87 def peering_status @peering_status end |
#time_created ⇒ DateTime
[Required] The date and time the RPC was created, in the format defined by RFC3339.
Example: ‘2016-08-25T21:10:29.600Z`
94 95 96 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 94 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 97 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'display_name': :'displayName', 'drg_id': :'drgId', 'id': :'id', 'is_cross_tenancy_peering': :'isCrossTenancyPeering', 'lifecycle_state': :'lifecycleState', 'peer_id': :'peerId', 'peer_region_name': :'peerRegionName', 'peer_tenancy_id': :'peerTenancyId', 'peering_status': :'peeringStatus', 'time_created': :'timeCreated' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 116 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'display_name': :'String', 'drg_id': :'String', 'id': :'String', 'is_cross_tenancy_peering': :'BOOLEAN', 'lifecycle_state': :'String', 'peer_id': :'String', 'peer_region_name': :'String', 'peer_tenancy_id': :'String', 'peering_status': :'String', 'time_created': :'DateTime' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 257 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && display_name == other.display_name && drg_id == other.drg_id && id == other.id && is_cross_tenancy_peering == other.is_cross_tenancy_peering && lifecycle_state == other.lifecycle_state && peer_id == other.peer_id && peer_region_name == other.peer_region_name && peer_tenancy_id == other.peer_tenancy_id && peering_status == other.peering_status && time_created == other.time_created end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 296 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
276 277 278 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 276 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
285 286 287 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 285 def hash [compartment_id, display_name, drg_id, id, is_cross_tenancy_peering, lifecycle_state, peer_id, peer_region_name, peer_tenancy_id, peering_status, time_created].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
328 329 330 331 332 333 334 335 336 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 328 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
322 323 324 |
# File 'lib/oci/core/models/remote_peering_connection.rb', line 322 def to_s to_hash.to_s end |