Class: OCI::Core::Models::VirtualCircuit

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/virtual_circuit.rb

Overview

For use with Oracle Cloud Infrastructure FastConnect.

A virtual circuit is an isolated network path that runs over one or more physical network connections to provide a single, logical connection between the edge router on the customer's existing network and Oracle Cloud Infrastructure. Private virtual circuits support private peering, and public virtual circuits support public peering. For more information, see FastConnect Overview.

Each virtual circuit is made up of information shared between a customer, Oracle, and a provider (if the customer is using FastConnect via a provider). Who fills in a given property of a virtual circuit depends on whether the BGP session related to that virtual circuit goes from the customer's edge router to Oracle, or from the provider's edge router to Oracle. Also, in the case where the customer is using a provider, values for some of the properties may not be present immediately, but may get filled in as the provider and Oracle each do their part to provision the virtual circuit.

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

BGP_MANAGEMENT_ENUM = 
[
  BGP_MANAGEMENT_CUSTOMER_MANAGED = 'CUSTOMER_MANAGED'.freeze,
  BGP_MANAGEMENT_PROVIDER_MANAGED = 'PROVIDER_MANAGED'.freeze,
  BGP_MANAGEMENT_ORACLE_MANAGED = 'ORACLE_MANAGED'.freeze,
  BGP_MANAGEMENT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
BGP_SESSION_STATE_ENUM = 
[
  BGP_SESSION_STATE_UP = 'UP'.freeze,
  BGP_SESSION_STATE_DOWN = 'DOWN'.freeze,
  BGP_SESSION_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
BGP_IPV6_SESSION_STATE_ENUM = 
[
  BGP_IPV6_SESSION_STATE_UP = 'UP'.freeze,
  BGP_IPV6_SESSION_STATE_DOWN = 'DOWN'.freeze,
  BGP_IPV6_SESSION_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ROUTING_POLICY_ENUM = 
[
  ROUTING_POLICY_ORACLE_SERVICE_NETWORK = 'ORACLE_SERVICE_NETWORK'.freeze,
  ROUTING_POLICY_REGIONAL = 'REGIONAL'.freeze,
  ROUTING_POLICY_MARKET_LEVEL = 'MARKET_LEVEL'.freeze,
  ROUTING_POLICY_GLOBAL = 'GLOBAL'.freeze,
  ROUTING_POLICY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
BGP_ADMIN_STATE_ENUM = 
[
  BGP_ADMIN_STATE_ENABLED = 'ENABLED'.freeze,
  BGP_ADMIN_STATE_DISABLED = 'DISABLED'.freeze,
  BGP_ADMIN_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_PENDING_PROVIDER = 'PENDING_PROVIDER'.freeze,
  LIFECYCLE_STATE_VERIFYING = 'VERIFYING'.freeze,
  LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
  LIFECYCLE_STATE_PROVISIONED = 'PROVISIONED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
PROVIDER_STATE_ENUM = 
[
  PROVIDER_STATE_ACTIVE = 'ACTIVE'.freeze,
  PROVIDER_STATE_INACTIVE = 'INACTIVE'.freeze,
  PROVIDER_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SERVICE_TYPE_ENUM = 
[
  SERVICE_TYPE_COLOCATED = 'COLOCATED'.freeze,
  SERVICE_TYPE_LAYER2 = 'LAYER2'.freeze,
  SERVICE_TYPE_LAYER3 = 'LAYER3'.freeze,
  SERVICE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TYPE_ENUM = 
[
  TYPE_PUBLIC = 'PUBLIC'.freeze,
  TYPE_PRIVATE = 'PRIVATE'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
IP_MTU_ENUM = 
[
  IP_MTU_MTU_1500 = 'MTU_1500'.freeze,
  IP_MTU_MTU_9000 = 'MTU_9000'.freeze,
  IP_MTU_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TRAFFIC_MODE_ENUM = 
[
  TRAFFIC_MODE_NORMAL = 'NORMAL'.freeze,
  TRAFFIC_MODE_DRAIN = 'DRAIN'.freeze,
  TRAFFIC_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VirtualCircuit

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 446

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.bandwidth_shape_name = attributes[:'bandwidthShapeName'] if attributes[:'bandwidthShapeName']

  raise 'You cannot provide both :bandwidthShapeName and :bandwidth_shape_name' if attributes.key?(:'bandwidthShapeName') && attributes.key?(:'bandwidth_shape_name')

  self.bandwidth_shape_name = attributes[:'bandwidth_shape_name'] if attributes[:'bandwidth_shape_name']

  self.bgp_management = attributes[:'bgpManagement'] if attributes[:'bgpManagement']

  raise 'You cannot provide both :bgpManagement and :bgp_management' if attributes.key?(:'bgpManagement') && attributes.key?(:'bgp_management')

  self.bgp_management = attributes[:'bgp_management'] if attributes[:'bgp_management']

  self.bgp_session_state = attributes[:'bgpSessionState'] if attributes[:'bgpSessionState']

  raise 'You cannot provide both :bgpSessionState and :bgp_session_state' if attributes.key?(:'bgpSessionState') && attributes.key?(:'bgp_session_state')

  self.bgp_session_state = attributes[:'bgp_session_state'] if attributes[:'bgp_session_state']

  self.bgp_ipv6_session_state = attributes[:'bgpIpv6SessionState'] if attributes[:'bgpIpv6SessionState']

  raise 'You cannot provide both :bgpIpv6SessionState and :bgp_ipv6_session_state' if attributes.key?(:'bgpIpv6SessionState') && attributes.key?(:'bgp_ipv6_session_state')

  self.bgp_ipv6_session_state = attributes[:'bgp_ipv6_session_state'] if attributes[:'bgp_ipv6_session_state']

  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.cross_connect_mappings = attributes[:'crossConnectMappings'] if attributes[:'crossConnectMappings']

  raise 'You cannot provide both :crossConnectMappings and :cross_connect_mappings' if attributes.key?(:'crossConnectMappings') && attributes.key?(:'cross_connect_mappings')

  self.cross_connect_mappings = attributes[:'cross_connect_mappings'] if attributes[:'cross_connect_mappings']

  self.routing_policy = attributes[:'routingPolicy'] if attributes[:'routingPolicy']

  raise 'You cannot provide both :routingPolicy and :routing_policy' if attributes.key?(:'routingPolicy') && attributes.key?(:'routing_policy')

  self.routing_policy = attributes[:'routing_policy'] if attributes[:'routing_policy']

  self.bgp_admin_state = attributes[:'bgpAdminState'] if attributes[:'bgpAdminState']

  raise 'You cannot provide both :bgpAdminState and :bgp_admin_state' if attributes.key?(:'bgpAdminState') && attributes.key?(:'bgp_admin_state')

  self.bgp_admin_state = attributes[:'bgp_admin_state'] if attributes[:'bgp_admin_state']

  self.is_bfd_enabled = attributes[:'isBfdEnabled'] unless attributes[:'isBfdEnabled'].nil?
  self.is_bfd_enabled = false if is_bfd_enabled.nil? && !attributes.key?(:'isBfdEnabled') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isBfdEnabled and :is_bfd_enabled' if attributes.key?(:'isBfdEnabled') && attributes.key?(:'is_bfd_enabled')

  self.is_bfd_enabled = attributes[:'is_bfd_enabled'] unless attributes[:'is_bfd_enabled'].nil?
  self.is_bfd_enabled = false if is_bfd_enabled.nil? && !attributes.key?(:'isBfdEnabled') && !attributes.key?(:'is_bfd_enabled') # rubocop:disable Style/StringLiterals

  self.is_transport_mode = attributes[:'isTransportMode'] unless attributes[:'isTransportMode'].nil?
  self.is_transport_mode = false if is_transport_mode.nil? && !attributes.key?(:'isTransportMode') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isTransportMode and :is_transport_mode' if attributes.key?(:'isTransportMode') && attributes.key?(:'is_transport_mode')

  self.is_transport_mode = attributes[:'is_transport_mode'] unless attributes[:'is_transport_mode'].nil?
  self.is_transport_mode = false if is_transport_mode.nil? && !attributes.key?(:'isTransportMode') && !attributes.key?(:'is_transport_mode') # rubocop:disable Style/StringLiterals

  self.customer_bgp_asn = attributes[:'customerBgpAsn'] if attributes[:'customerBgpAsn']

  raise 'You cannot provide both :customerBgpAsn and :customer_bgp_asn' if attributes.key?(:'customerBgpAsn') && attributes.key?(:'customer_bgp_asn')

  self.customer_bgp_asn = attributes[:'customer_bgp_asn'] if attributes[:'customer_bgp_asn']

  self.customer_asn = attributes[:'customerAsn'] if attributes[:'customerAsn']

  raise 'You cannot provide both :customerAsn and :customer_asn' if attributes.key?(:'customerAsn') && attributes.key?(:'customer_asn')

  self.customer_asn = attributes[:'customer_asn'] if attributes[:'customer_asn']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = 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.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.gateway_id = attributes[:'gatewayId'] if attributes[:'gatewayId']

  raise 'You cannot provide both :gatewayId and :gateway_id' if attributes.key?(:'gatewayId') && attributes.key?(:'gateway_id')

  self.gateway_id = attributes[:'gateway_id'] if attributes[:'gateway_id']

  self.id = attributes[:'id'] if attributes[:'id']

  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.oracle_bgp_asn = attributes[:'oracleBgpAsn'] if attributes[:'oracleBgpAsn']

  raise 'You cannot provide both :oracleBgpAsn and :oracle_bgp_asn' if attributes.key?(:'oracleBgpAsn') && attributes.key?(:'oracle_bgp_asn')

  self.oracle_bgp_asn = attributes[:'oracle_bgp_asn'] if attributes[:'oracle_bgp_asn']

  self.provider_name = attributes[:'providerName'] if attributes[:'providerName']

  raise 'You cannot provide both :providerName and :provider_name' if attributes.key?(:'providerName') && attributes.key?(:'provider_name')

  self.provider_name = attributes[:'provider_name'] if attributes[:'provider_name']

  self.provider_service_id = attributes[:'providerServiceId'] if attributes[:'providerServiceId']

  raise 'You cannot provide both :providerServiceId and :provider_service_id' if attributes.key?(:'providerServiceId') && attributes.key?(:'provider_service_id')

  self.provider_service_id = attributes[:'provider_service_id'] if attributes[:'provider_service_id']

  self.provider_service_key_name = attributes[:'providerServiceKeyName'] if attributes[:'providerServiceKeyName']

  raise 'You cannot provide both :providerServiceKeyName and :provider_service_key_name' if attributes.key?(:'providerServiceKeyName') && attributes.key?(:'provider_service_key_name')

  self.provider_service_key_name = attributes[:'provider_service_key_name'] if attributes[:'provider_service_key_name']

  self.provider_service_name = attributes[:'providerServiceName'] if attributes[:'providerServiceName']

  raise 'You cannot provide both :providerServiceName and :provider_service_name' if attributes.key?(:'providerServiceName') && attributes.key?(:'provider_service_name')

  self.provider_service_name = attributes[:'provider_service_name'] if attributes[:'provider_service_name']

  self.provider_state = attributes[:'providerState'] if attributes[:'providerState']

  raise 'You cannot provide both :providerState and :provider_state' if attributes.key?(:'providerState') && attributes.key?(:'provider_state')

  self.provider_state = attributes[:'provider_state'] if attributes[:'provider_state']

  self.public_prefixes = attributes[:'publicPrefixes'] if attributes[:'publicPrefixes']

  raise 'You cannot provide both :publicPrefixes and :public_prefixes' if attributes.key?(:'publicPrefixes') && attributes.key?(:'public_prefixes')

  self.public_prefixes = attributes[:'public_prefixes'] if attributes[:'public_prefixes']

  self.reference_comment = attributes[:'referenceComment'] if attributes[:'referenceComment']

  raise 'You cannot provide both :referenceComment and :reference_comment' if attributes.key?(:'referenceComment') && attributes.key?(:'reference_comment')

  self.reference_comment = attributes[:'reference_comment'] if attributes[:'reference_comment']

  self.region = attributes[:'region'] if attributes[:'region']

  self.service_type = attributes[:'serviceType'] if attributes[:'serviceType']

  raise 'You cannot provide both :serviceType and :service_type' if attributes.key?(:'serviceType') && attributes.key?(:'service_type')

  self.service_type = attributes[:'service_type'] if attributes[:'service_type']

  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.type = attributes[:'type'] if attributes[:'type']

  self.ip_mtu = attributes[:'ipMtu'] if attributes[:'ipMtu']

  raise 'You cannot provide both :ipMtu and :ip_mtu' if attributes.key?(:'ipMtu') && attributes.key?(:'ip_mtu')

  self.ip_mtu = attributes[:'ip_mtu'] if attributes[:'ip_mtu']

  self.provider_remote_region = attributes[:'providerRemoteRegion'] if attributes[:'providerRemoteRegion']

  raise 'You cannot provide both :providerRemoteRegion and :provider_remote_region' if attributes.key?(:'providerRemoteRegion') && attributes.key?(:'provider_remote_region')

  self.provider_remote_region = attributes[:'provider_remote_region'] if attributes[:'provider_remote_region']

  self.shared_connection_uuid = attributes[:'sharedConnectionUuid'] if attributes[:'sharedConnectionUuid']

  raise 'You cannot provide both :sharedConnectionUuid and :shared_connection_uuid' if attributes.key?(:'sharedConnectionUuid') && attributes.key?(:'shared_connection_uuid')

  self.shared_connection_uuid = attributes[:'shared_connection_uuid'] if attributes[:'shared_connection_uuid']

  self. = attributes[:'remoteAccountId'] if attributes[:'remoteAccountId']

  raise 'You cannot provide both :remoteAccountId and :remote_account_id' if attributes.key?(:'remoteAccountId') && attributes.key?(:'remote_account_id')

  self. = attributes[:'remote_account_id'] if attributes[:'remote_account_id']

  self.traffic_mode = attributes[:'trafficMode'] if attributes[:'trafficMode']

  raise 'You cannot provide both :trafficMode and :traffic_mode' if attributes.key?(:'trafficMode') && attributes.key?(:'traffic_mode')

  self.traffic_mode = attributes[:'traffic_mode'] if attributes[:'traffic_mode']

  self.virtual_circuit_redundancy_metadata = attributes[:'virtualCircuitRedundancyMetadata'] if attributes[:'virtualCircuitRedundancyMetadata']

  raise 'You cannot provide both :virtualCircuitRedundancyMetadata and :virtual_circuit_redundancy_metadata' if attributes.key?(:'virtualCircuitRedundancyMetadata') && attributes.key?(:'virtual_circuit_redundancy_metadata')

  self.virtual_circuit_redundancy_metadata = attributes[:'virtual_circuit_redundancy_metadata'] if attributes[:'virtual_circuit_redundancy_metadata']
end

Instance Attribute Details

#bandwidth_shape_name ⇒ String

The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see list_fast_connect_provider_virtual_circuit_bandwidth_shapes.

Example: 10 Gbps

Returns:

  • (String) 


114
115
116
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 114

def bandwidth_shape_name
  @bandwidth_shape_name
end

#bgp_admin_state ⇒ String

Set to ENABLED (the default) to activate the BGP session of the virtual circuit, set to DISABLED to deactivate the virtual circuit.

Returns:

  • (String) 


152
153
154
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 152

def bgp_admin_state
  @bgp_admin_state
end

#bgp_ipv6_session_state ⇒ String

The state of the Ipv6 BGP session associated with the virtual circuit.

Returns:

  • (String) 


128
129
130
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 128

def bgp_ipv6_session_state
  @bgp_ipv6_session_state
end

#bgp_management ⇒ String

Deprecated. Instead use the information in FastConnectProviderService.

Returns:

  • (String) 


120
121
122
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 120

def bgp_management
  @bgp_management
end

#bgp_session_state ⇒ String

The state of the Ipv4 BGP session associated with the virtual circuit.

Returns:

  • (String) 


124
125
126
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 124

def bgp_session_state
  @bgp_session_state
end

#compartment_id ⇒ String

The OCID of the compartment containing the virtual circuit.

Returns:

  • (String) 


132
133
134
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 132

def compartment_id
  @compartment_id
end

#cross_connect_mappings ⇒ Array<OCI::Core::Models::CrossConnectMapping>

An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.

Returns:



139
140
141
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 139

def cross_connect_mappings
  @cross_connect_mappings
end

#customer_asn ⇒ Integer

The BGP ASN of the network at the other end of the BGP session from Oracle. If the session is between the customer's edge router and Oracle, the value is the customer's ASN. If the BGP session is between the provider's edge router and Oracle, the value is the provider's ASN. Can be a 2-byte or 4-byte ASN. Uses "asplain" format.

Returns:

  • (Integer) 


178
179
180
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 178

def customer_asn
  @customer_asn
end

#customer_bgp_asn ⇒ Integer

Deprecated. Instead use customerAsn. If you specify values for both, the request will be rejected.

Returns:

  • (Integer) 


168
169
170
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 168

def customer_bgp_asn
  @customer_bgp_asn
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\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


186
187
188
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 186

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


192
193
194
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 192

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\"}

Returns:

  • (Hash<String, String>) 


200
201
202
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 200

def freeform_tags
  @freeform_tags
end

#gateway_id ⇒ String

The OCID of the customer's Drg that this virtual circuit uses. Applicable only to private virtual circuits.

Returns:

  • (String) 


206
207
208
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 206

def gateway_id
  @gateway_id
end

#id ⇒ String

The virtual circuit's Oracle ID (OCID).

Returns:

  • (String) 


210
211
212
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 210

def id
  @id
end

#ip_mtu ⇒ String

The layer 3 IP MTU to use on this virtual circuit.

Returns:

  • (String) 


291
292
293
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 291

def ip_mtu
  @ip_mtu
end

#is_bfd_enabled ⇒ BOOLEAN

Set to true to enable BFD for IPv4 BGP peering, or set to false to disable BFD. If this is not set, the default is false.

Returns:

  • (BOOLEAN) 


157
158
159
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 157

def is_bfd_enabled
  @is_bfd_enabled
end

#is_transport_mode ⇒ BOOLEAN

Set to true for the virtual circuit to carry only encrypted traffic, or set to false for the virtual circuit to carry unencrypted traffic. If this is not set, the default is false.

Returns:

  • (BOOLEAN) 


162
163
164
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 162

def is_transport_mode
  @is_transport_mode
end

#lifecycle_state ⇒ String

The virtual circuit's current state. For information about the different states, see FastConnect Overview.

Returns:

  • (String) 


217
218
219
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 217

def lifecycle_state
  @lifecycle_state
end

#oracle_bgp_asn ⇒ Integer

The Oracle BGP ASN.

Returns:

  • (Integer) 


221
222
223
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 221

def oracle_bgp_asn
  @oracle_bgp_asn
end

#provider_name ⇒ String

Deprecated. Instead use providerServiceId.

Returns:

  • (String) 


226
227
228
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 226

def provider_name
  @provider_name
end

#provider_remote_region ⇒ String

The OCI's FastConnect MultiCloud Provider/Partner remote region name associated with the OCI region. To get the list of associated provider remote region use the ListProviderRemoteRegions operation

Returns:

  • (String) 


297
298
299
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 297

def provider_remote_region
  @provider_remote_region
end

#provider_service_id ⇒ String

The OCID of the service offered by the provider (if the customer is connecting via a provider).

Returns:

  • (String) 


231
232
233
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 231

def provider_service_id
  @provider_service_id
end

#provider_service_key_name ⇒ String

The service key name offered by the provider (if the customer is connecting via a provider).

Returns:

  • (String) 


236
237
238
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 236

def provider_service_key_name
  @provider_service_key_name
end

#provider_service_name ⇒ String

Deprecated. Instead use providerServiceId.

Returns:

  • (String) 


241
242
243
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 241

def provider_service_name
  @provider_service_name
end

#provider_state ⇒ String

The provider's state in relation to this virtual circuit (if the customer is connecting via a provider). ACTIVE means the provider has provisioned the virtual circuit from their end. INACTIVE means the provider has not yet provisioned the virtual circuit, or has de-provisioned it.

Returns:

  • (String) 


250
251
252
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 250

def provider_state
  @provider_state
end

#public_prefixes ⇒ Array<String>

For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection. All prefix sizes are allowed.

Returns:

  • (Array<String>) 


256
257
258
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 256

def public_prefixes
  @public_prefixes
end

#reference_comment ⇒ String

Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).

Returns:

  • (String) 


262
263
264
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 262

def reference_comment
  @reference_comment
end

#region ⇒ String

The Oracle Cloud Infrastructure region where this virtual circuit is located.

Returns:

  • (String) 


268
269
270
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 268

def region
  @region
end

#remote_account_id ⇒ String

Customer's account on Provider/Partner cloud (AWS, GCP or any other)

Returns:

  • (String) 


305
306
307
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 305

def 
  @remote_account_id
end

#routing_policy ⇒ Array<String>

The routing policy sets how routing information about the Oracle cloud is shared over a public virtual circuit. Policies available are: ORACLE_SERVICE_NETWORK, REGIONAL, MARKET_LEVEL, and GLOBAL. See Route Filtering for details. By default, routing information is shared for all routes in the same market.

Returns:

  • (Array<String>) 


147
148
149
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 147

def routing_policy
  @routing_policy
end

#service_type ⇒ String

Provider service type.

Returns:

  • (String) 


273
274
275
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 273

def service_type
  @service_type
end

#shared_connection_uuid ⇒ String

The Shared unique identifier for the connection between the multicloud interconnect providers

Returns:

  • (String) 


301
302
303
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 301

def shared_connection_uuid
  @shared_connection_uuid
end

#time_created ⇒ DateTime

The date and time the virtual circuit was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


281
282
283
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 281

def time_created
  @time_created
end

#traffic_mode ⇒ String

The current traffic mode for the Virtual Circuit. This indicates whether the traffic is drained for the associated Virtual Circuit or not.

Returns:

  • (String) 


311
312
313
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 311

def traffic_mode
  @traffic_mode
end

#type ⇒ String

Whether the virtual circuit supports private or public peering. For more information, see FastConnect Overview.

Returns:

  • (String) 


287
288
289
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 287

def type
  @type
end

#virtual_circuit_redundancy_metadata ⇒ OCI::Core::Models::VirtualCircuitRedundancyMetadata

Returns:



314
315
316
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 314

def virtual_circuit_redundancy_metadata
  @virtual_circuit_redundancy_metadata
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 317

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'bandwidth_shape_name': :'bandwidthShapeName',
    'bgp_management': :'bgpManagement',
    'bgp_session_state': :'bgpSessionState',
    'bgp_ipv6_session_state': :'bgpIpv6SessionState',
    'compartment_id': :'compartmentId',
    'cross_connect_mappings': :'crossConnectMappings',
    'routing_policy': :'routingPolicy',
    'bgp_admin_state': :'bgpAdminState',
    'is_bfd_enabled': :'isBfdEnabled',
    'is_transport_mode': :'isTransportMode',
    'customer_bgp_asn': :'customerBgpAsn',
    'customer_asn': :'customerAsn',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'gateway_id': :'gatewayId',
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'oracle_bgp_asn': :'oracleBgpAsn',
    'provider_name': :'providerName',
    'provider_service_id': :'providerServiceId',
    'provider_service_key_name': :'providerServiceKeyName',
    'provider_service_name': :'providerServiceName',
    'provider_state': :'providerState',
    'public_prefixes': :'publicPrefixes',
    'reference_comment': :'referenceComment',
    'region': :'region',
    'service_type': :'serviceType',
    'time_created': :'timeCreated',
    'type': :'type',
    'ip_mtu': :'ipMtu',
    'provider_remote_region': :'providerRemoteRegion',
    'shared_connection_uuid': :'sharedConnectionUuid',
    'remote_account_id': :'remoteAccountId',
    'traffic_mode': :'trafficMode',
    'virtual_circuit_redundancy_metadata': :'virtualCircuitRedundancyMetadata'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 361

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'bandwidth_shape_name': :'String',
    'bgp_management': :'String',
    'bgp_session_state': :'String',
    'bgp_ipv6_session_state': :'String',
    'compartment_id': :'String',
    'cross_connect_mappings': :'Array<OCI::Core::Models::CrossConnectMapping>',
    'routing_policy': :'Array<String>',
    'bgp_admin_state': :'String',
    'is_bfd_enabled': :'BOOLEAN',
    'is_transport_mode': :'BOOLEAN',
    'customer_bgp_asn': :'Integer',
    'customer_asn': :'Integer',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'gateway_id': :'String',
    'id': :'String',
    'lifecycle_state': :'String',
    'oracle_bgp_asn': :'Integer',
    'provider_name': :'String',
    'provider_service_id': :'String',
    'provider_service_key_name': :'String',
    'provider_service_name': :'String',
    'provider_state': :'String',
    'public_prefixes': :'Array<String>',
    'reference_comment': :'String',
    'region': :'String',
    'service_type': :'String',
    'time_created': :'DateTime',
    'type': :'String',
    'ip_mtu': :'String',
    'provider_remote_region': :'String',
    'shared_connection_uuid': :'String',
    'remote_account_id': :'String',
    'traffic_mode': :'String',
    'virtual_circuit_redundancy_metadata': :'OCI::Core::Models::VirtualCircuitRedundancyMetadata'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 818

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    bandwidth_shape_name == other.bandwidth_shape_name &&
    bgp_management == other.bgp_management &&
    bgp_session_state == other.bgp_session_state &&
    bgp_ipv6_session_state == other.bgp_ipv6_session_state &&
    compartment_id == other.compartment_id &&
    cross_connect_mappings == other.cross_connect_mappings &&
    routing_policy == other.routing_policy &&
    bgp_admin_state == other.bgp_admin_state &&
    is_bfd_enabled == other.is_bfd_enabled &&
    is_transport_mode == other.is_transport_mode &&
    customer_bgp_asn == other.customer_bgp_asn &&
    customer_asn == other.customer_asn &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    gateway_id == other.gateway_id &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    oracle_bgp_asn == other.oracle_bgp_asn &&
    provider_name == other.provider_name &&
    provider_service_id == other.provider_service_id &&
    provider_service_key_name == other.provider_service_key_name &&
    provider_service_name == other.provider_service_name &&
    provider_state == other.provider_state &&
    public_prefixes == other.public_prefixes &&
    reference_comment == other.reference_comment &&
    region == other.region &&
    service_type == other.service_type &&
    time_created == other.time_created &&
    type == other.type &&
    ip_mtu == other.ip_mtu &&
    provider_remote_region == other.provider_remote_region &&
    shared_connection_uuid == other.shared_connection_uuid &&
     == other. &&
    traffic_mode == other.traffic_mode &&
    virtual_circuit_redundancy_metadata == other.virtual_circuit_redundancy_metadata
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



883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 883

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


863
864
865
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 863

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



872
873
874
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 872

def hash
  [bandwidth_shape_name, bgp_management, bgp_session_state, bgp_ipv6_session_state, compartment_id, cross_connect_mappings, routing_policy, bgp_admin_state, is_bfd_enabled, is_transport_mode, customer_bgp_asn, customer_asn, defined_tags, display_name, freeform_tags, gateway_id, id, lifecycle_state, oracle_bgp_asn, provider_name, provider_service_id, provider_service_key_name, provider_service_name, provider_state, public_prefixes, reference_comment, region, service_type, time_created, type, ip_mtu, provider_remote_region, shared_connection_uuid, , traffic_mode, virtual_circuit_redundancy_metadata].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



916
917
918
919
920
921
922
923
924
925
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 916

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

Returns:

  • (String) —

    String presentation of the object



910
911
912
 
# File 'lib/oci/core/models/virtual_circuit.rb', line 910

def to_s
  to_hash.to_s
end