Package com.oracle.bmc.vnmonitoring.model

Class VirtualCircuit

  • @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.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.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).

    • Method Detail

      • getBandwidthShapeName

        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

        Returns:
        the value

      • getBgpSessionState

        public VirtualCircuit.BgpSessionState getBgpSessionState()
        The state of the Ipv4 BGP session associated with the virtual circuit.
        Returns:
        the value

      • getBgpIpv6SessionState

        public VirtualCircuit.BgpIpv6SessionState getBgpIpv6SessionState()
        The state of the Ipv6 BGP session associated with the virtual circuit.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing the virtual circuit.
        Returns:
        the value

      • getCrossConnectMappings

        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.
        Returns:
        the value

      • getRoutingPolicy

        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.

        Returns:
        the value

      • getBgpAdminState

        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.
        Returns:
        the value

      • getIsBfdEnabled

        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.

        Returns:
        the value

      • getIsTransportMode

        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.

        Returns:
        the value

      • getCustomerBgpAsn

        public Integer getCustomerBgpAsn()
        Deprecated.

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

        Returns:
        the value

      • getCustomerAsn

        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.

        Returns:
        the value

      • getDefinedTags

        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”}}

        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Returns:
        the value

      • getFreeformTags

        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”}

        Returns:
        the value

      • getGatewayId

        public String getGatewayId()
        The OCID of the customer’s Drg that this virtual circuit uses.

        Applicable only to private virtual circuits.

        Returns:
        the value

      • getId

        public String getId()
        The virtual circuit’s Oracle ID (OCID).
        Returns:
        the value

      • getOracleBgpAsn

        public Integer getOracleBgpAsn()
        The Oracle BGP ASN.
        Returns:
        the value

      • getProviderName

        public String getProviderName()
        Deprecated.

        Instead use providerServiceId.

        Returns:
        the value

      • getProviderServiceId

        public String getProviderServiceId()
        The OCID of the service offered by the provider (if the customer is connecting via a provider).
        Returns:
        the value

      • getProviderServiceKeyName

        public String getProviderServiceKeyName()
        The service key name offered by the provider (if the customer is connecting via a provider).
        Returns:
        the value

      • getProviderServiceName

        public String getProviderServiceName()
        Deprecated.

        Instead use providerServiceId.

        Returns:
        the value

      • getProviderState

        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.

        Returns:
        the value

      • getPublicPrefixes

        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.

        Returns:
        the value

      • getReferenceComment

        public String getReferenceComment()
        Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).
        Returns:
        the value

      • getRegion

        public String getRegion()
        The Oracle Cloud Infrastructure region where this virtual circuit is located.
        Returns:
        the value

      • getTimeCreated

        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

        Returns:
        the value

      • getIpMtu

        public VirtualCircuitIpMtu getIpMtu()
        The layer 3 IP MTU to use on this virtual circuit.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel