@Generated(value="OracleSDKGenerator",
comments="API Version: 20160918")
public final class VirtualCircuit
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm).
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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
Note: Objects should always be created or deserialized using the VirtualCircuit.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the VirtualCircuit.Builder, which maintain a
set of all explicitly set fields called VirtualCircuit.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
VirtualCircuit.BgpAdminState
Set to
ENABLED (the default) to activate the BGP session of the virtual circuit, set
to DISABLED to deactivate the virtual circuit. |
static class |
VirtualCircuit.BgpIpv6SessionState
The state of the Ipv6 BGP session associated with the virtual circuit.
|
static class |
VirtualCircuit.BgpManagement
Deprecated.
|
static class |
VirtualCircuit.BgpSessionState
The state of the Ipv4 BGP session associated with the virtual circuit.
|
static class |
VirtualCircuit.Builder |
static class |
VirtualCircuit.LifecycleState
The virtual circuit’s current state.
|
static class |
VirtualCircuit.ProviderState
The provider’s state in relation to this virtual circuit (if the customer is connecting via a
provider).
|
static class |
VirtualCircuit.RoutingPolicy |
static class |
VirtualCircuit.ServiceType
Provider service type.
|
static class |
VirtualCircuit.Type
Whether the virtual circuit supports private or public peering.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
VirtualCircuit(String bandwidthShapeName,
VirtualCircuit.BgpManagement bgpManagement,
VirtualCircuit.BgpSessionState bgpSessionState,
VirtualCircuit.BgpIpv6SessionState bgpIpv6SessionState,
String compartmentId,
List<CrossConnectMapping> crossConnectMappings,
List<VirtualCircuit.RoutingPolicy> routingPolicy,
VirtualCircuit.BgpAdminState bgpAdminState,
Boolean isBfdEnabled,
Boolean isTransportMode,
Integer customerBgpAsn,
Long customerAsn,
Map<String,Map<String,Object>> definedTags,
String displayName,
Map<String,String> freeformTags,
String gatewayId,
String id,
VirtualCircuit.LifecycleState lifecycleState,
Integer oracleBgpAsn,
String providerName,
String providerServiceId,
String providerServiceKeyName,
String providerServiceName,
VirtualCircuit.ProviderState providerState,
List<String> publicPrefixes,
String referenceComment,
String region,
VirtualCircuit.ServiceType serviceType,
Date timeCreated,
VirtualCircuit.Type type,
VirtualCircuitIpMtu ipMtu)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static VirtualCircuit.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getBandwidthShapeName()
The provisioned data rate of the connection.
|
VirtualCircuit.BgpAdminState |
getBgpAdminState()
Set to
ENABLED (the default) to activate the BGP session of the virtual circuit, set
to DISABLED to deactivate the virtual circuit. |
VirtualCircuit.BgpIpv6SessionState |
getBgpIpv6SessionState()
The state of the Ipv6 BGP session associated with the virtual circuit.
|
VirtualCircuit.BgpManagement |
getBgpManagement()
Deprecated.
|
VirtualCircuit.BgpSessionState |
getBgpSessionState()
The state of the Ipv4 BGP session associated with the virtual circuit.
|
String |
getCompartmentId()
The OCID of
the compartment containing the virtual circuit.
|
List<CrossConnectMapping> |
getCrossConnectMappings()
An array of mappings, each containing properties for a cross-connect or cross-connect group
that is associated with this virtual circuit.
|
Long |
getCustomerAsn()
The BGP ASN of the network at the other end of the BGP session from Oracle.
|
Integer |
getCustomerBgpAsn()
Deprecated.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
String |
getGatewayId()
|
String |
getId()
The virtual circuit’s Oracle ID
(OCID).
|
VirtualCircuitIpMtu |
getIpMtu()
The layer 3 IP MTU to use on this virtual circuit.
|
Boolean |
getIsBfdEnabled()
Set to
true to enable BFD for IPv4 BGP peering, or set to false to disable
BFD. |
Boolean |
getIsTransportMode()
Set to
true for the virtual circuit to carry only encrypted traffic, or set to false for the virtual circuit to carry unencrypted traffic. |
VirtualCircuit.LifecycleState |
getLifecycleState()
The virtual circuit’s current state.
|
Integer |
getOracleBgpAsn()
The Oracle BGP ASN.
|
String |
getProviderName()
Deprecated.
|
String |
getProviderServiceId()
The OCID of
the service offered by the provider (if the customer is connecting via a provider).
|
String |
getProviderServiceKeyName()
The service key name offered by the provider (if the customer is connecting via a provider).
|
String |
getProviderServiceName()
Deprecated.
|
VirtualCircuit.ProviderState |
getProviderState()
The provider’s state in relation to this virtual circuit (if the customer is connecting via a
provider).
|
List<String> |
getPublicPrefixes()
For a public virtual circuit.
|
String |
getReferenceComment()
Provider-supplied reference information about this virtual circuit (if the customer is
connecting via a provider).
|
String |
getRegion()
The Oracle Cloud Infrastructure region where this virtual circuit is located.
|
List<VirtualCircuit.RoutingPolicy> |
getRoutingPolicy()
The routing policy sets how routing information about the Oracle cloud is shared over a
public virtual circuit.
|
VirtualCircuit.ServiceType |
getServiceType()
Provider service type.
|
Date |
getTimeCreated()
The date and time the virtual circuit was created, in the format defined by
RFC3339.
|
VirtualCircuit.Type |
getType()
Whether the virtual circuit supports private or public peering.
|
int |
hashCode() |
VirtualCircuit.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"bandwidthShapeName","bgpManagement","bgpSessionState","bgpIpv6SessionState","compartmentId","crossConnectMappings","routingPolicy","bgpAdminState","isBfdEnabled","isTransportMode","customerBgpAsn","customerAsn","definedTags","displayName","freeformTags","gatewayId","id","lifecycleState","oracleBgpAsn","providerName","providerServiceId","providerServiceKeyName","providerServiceName","providerState","publicPrefixes","referenceComment","region","serviceType","timeCreated","type","ipMtu"}) public VirtualCircuit(String bandwidthShapeName, VirtualCircuit.BgpManagement bgpManagement, VirtualCircuit.BgpSessionState bgpSessionState, VirtualCircuit.BgpIpv6SessionState bgpIpv6SessionState, String compartmentId, List<CrossConnectMapping> crossConnectMappings, List<VirtualCircuit.RoutingPolicy> routingPolicy, VirtualCircuit.BgpAdminState bgpAdminState, Boolean isBfdEnabled, Boolean isTransportMode, Integer customerBgpAsn, Long customerAsn, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String gatewayId, String id, VirtualCircuit.LifecycleState lifecycleState, Integer oracleBgpAsn, String providerName, String providerServiceId, String providerServiceKeyName, String providerServiceName, VirtualCircuit.ProviderState providerState, List<String> publicPrefixes, String referenceComment, String region, VirtualCircuit.ServiceType serviceType, Date timeCreated, VirtualCircuit.Type type, VirtualCircuitIpMtu ipMtu)
public static VirtualCircuit.Builder builder()
Create a new builder.
public VirtualCircuit.Builder toBuilder()
public String getBandwidthShapeName()
The provisioned data rate of the connection. To get a list of the available bandwidth levels
(that is, shapes), see listFastConnectProviderVirtualCircuitBandwidthShapes.
Example: 10 Gbps
public VirtualCircuit.BgpManagement getBgpManagement()
Deprecated. Instead use the information in FastConnectProviderService.
public VirtualCircuit.BgpSessionState getBgpSessionState()
The state of the Ipv4 BGP session associated with the virtual circuit.
public VirtualCircuit.BgpIpv6SessionState getBgpIpv6SessionState()
The state of the Ipv6 BGP session associated with the virtual circuit.
public String getCompartmentId()
The OCID of the compartment containing the virtual circuit.
public List<CrossConnectMapping> getCrossConnectMappings()
An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.
public List<VirtualCircuit.RoutingPolicy> getRoutingPolicy()
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.
public VirtualCircuit.BgpAdminState getBgpAdminState()
Set to ENABLED (the default) to activate the BGP session of the virtual circuit, set
to DISABLED to deactivate the virtual circuit.
public Boolean getIsBfdEnabled()
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.
public Boolean getIsTransportMode()
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.
public Integer getCustomerBgpAsn()
Deprecated. Instead use customerAsn. If you specify values for both, the request will
be rejected.
public Long getCustomerAsn()
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.
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}}
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope. Exists for
cross-compatibility only. Example: {"bar-key": "value"}
public String getGatewayId()
The OCID of
the customer’s Drg that this virtual circuit uses. Applicable only to private virtual
circuits.
public VirtualCircuit.LifecycleState getLifecycleState()
The virtual circuit’s current state. For information about the different states, see FastConnect Overview.
public Integer getOracleBgpAsn()
The Oracle BGP ASN.
public String getProviderName()
Deprecated. Instead use providerServiceId.
public String getProviderServiceId()
The OCID of the service offered by the provider (if the customer is connecting via a provider).
public String getProviderServiceKeyName()
The service key name offered by the provider (if the customer is connecting via a provider).
public String getProviderServiceName()
Deprecated. Instead use providerServiceId.
public VirtualCircuit.ProviderState getProviderState()
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.
public List<String> getPublicPrefixes()
For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection. All prefix sizes are allowed.
public String getReferenceComment()
Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).
public String getRegion()
The Oracle Cloud Infrastructure region where this virtual circuit is located.
public VirtualCircuit.ServiceType getServiceType()
Provider service type.
public Date getTimeCreated()
The date and time the virtual circuit was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
public VirtualCircuit.Type getType()
Whether the virtual circuit supports private or public peering. For more information, see FastConnect Overview.
public VirtualCircuitIpMtu getIpMtu()
The layer 3 IP MTU to use on this virtual circuit.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.