Package com.oracle.bmc.vnmonitoring.model

Class CrossConnectMapping

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class CrossConnectMapping
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    For use with Oracle Cloud Infrastructure FastConnect.

    Each VirtualCircuit runs on one or more cross-connects or cross-connect groups. A CrossConnectMapping contains the properties for an individual cross-connect or cross-connect group associated with a given virtual circuit.

    The mapping includes information about the cross-connect or cross-connect group, the VLAN, and the BGP peering session.

    If you're a customer who is colocated with Oracle, that means you own both the virtual circuit and the physical connection it runs on (cross-connect or cross-connect group), so you specify all the information in the mapping. There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

    If you're a provider, then you own the physical connection that the customer's virtual circuit runs on, so you contribute information about the cross-connect or cross-connect group and VLAN.

    Who specifies the BGP peering information in the case of customer connection via provider? If the BGP session goes from Oracle to the provider's edge router, then the provider also specifies the BGP peering information. If the BGP session instead goes from Oracle to the customer's edge router, then the customer specifies the BGP peering information. There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

    Every CrossConnectMapping must have BGP IPv4 peering addresses. BGP IPv6 peering addresses are optional. If BGP IPv6 addresses are provided, the customer can exchange IPv6 routes with Oracle.
    Note: Objects should always be created or deserialized using the CrossConnectMapping.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 CrossConnectMapping.Builder, which maintain a set of all explicitly set fields called CrossConnectMapping.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).

    • Constructor Detail

      • CrossConnectMapping

        @Deprecated
@ConstructorProperties({"bgpMd5AuthKey","crossConnectOrCrossConnectGroupId","customerBgpPeeringIp","oracleBgpPeeringIp","customerBgpPeeringIpv6","oracleBgpPeeringIpv6","vlan"})
public CrossConnectMapping​(String bgpMd5AuthKey,
                           String crossConnectOrCrossConnectGroupId,
                           String customerBgpPeeringIp,
                           String oracleBgpPeeringIp,
                           String customerBgpPeeringIpv6,
                           String oracleBgpPeeringIpv6,
                           Integer vlan)
        Deprecated.

    • Method Detail

      • getBgpMd5AuthKey

        public String getBgpMd5AuthKey()
        The key for BGP MD5 authentication.

        Only applicable if your system requires MD5 authentication. If empty or not set (null), that means you don’t use BGP MD5 authentication.

        Returns:
        the value

      • getCrossConnectOrCrossConnectGroupId

        public String getCrossConnectOrCrossConnectGroupId()
        The OCID of the cross-connect or cross-connect group for this mapping.

        Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider).

        Returns:
        the value

      • getCustomerBgpPeeringIp

        public String getCustomerBgpPeeringIp()
        The BGP IPv4 address for the router on the other end of the BGP session from Oracle.

        Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv4 address of the customer’s edge router. If the session goes from Oracle to a provider, this is the BGP IPv4 address of the provider’s edge router. Must use a subnet mask from /28 to /31.

        There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

        Example: 10.0.0.18/31

        Returns:
        the value

      • getOracleBgpPeeringIp

        public String getOracleBgpPeeringIp()
        The IPv4 address for Oracle’s end of the BGP session.

        Must use a subnet mask from /28 to /31. If the session goes from Oracle to a customer’s edge router, the customer specifies this information. If the session goes from Oracle to a provider’s edge router, the provider specifies this.

        There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

        Example: 10.0.0.19/31

        Returns:
        the value

      • getCustomerBgpPeeringIpv6

        public String getCustomerBgpPeeringIpv6()
        The BGP IPv6 address for the router on the other end of the BGP session from Oracle.

        Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv6 address of the customer’s edge router. If the session goes from Oracle to a provider, this is the BGP IPv6 address of the provider’s edge router. Only subnet masks from /64 up to /127 are allowed.

        There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.

        IPv6 addressing is supported for all commercial and government regions. See [IPv6 Addresses](https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).

        Example: 2001:db8::1/64

        Returns:
        the value

      • getOracleBgpPeeringIpv6

        public String getOracleBgpPeeringIpv6()
        The IPv6 address for Oracle’s end of the BGP session.

        Only subnet masks from /64 up to /127 are allowed. If the session goes from Oracle to a customer’s edge router, the customer specifies this information. If the session goes from Oracle to a provider’s edge router, the provider specifies this.

        There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.

        Note that IPv6 addressing is currently supported only in certain regions. See [IPv6 Addresses](https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).

        Example: 2001:db8::2/64

        Returns:
        the value

      • getVlan

        public Integer getVlan()
        The number of the specific VLAN (on the cross-connect or cross-connect group) that is assigned to this virtual circuit.

        Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider).

        Example: 200

        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