Package com.oracle.bmc.vnmonitoring.model

Class Cpe

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class Cpe
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    An object you create when setting up a Site-to-Site VPN between your on-premises network and VCN.

    The Cpe is a virtual representation of your customer-premises equipment, which is the actual router on-premises at your site at your end of the Site-to-Site VPN IPSec connection. For more information, see Overview of the Networking Service.

    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 Cpe.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 Cpe.Builder, which maintain a set of all explicitly set fields called Cpe.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

      • builder

        public static Cpe.Builder builder()
        Create a new builder.

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing the CPE.
        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

      • getId

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

      • getIpAddress

        public String getIpAddress()
        The public IP address of the on-premises router.
        Returns:
        the value

      • getCpeDeviceShapeId

        public String getCpeDeviceShapeId()
        The OCID of the CPE’s device type.

        The Networking service maintains a general list of CPE device types (for example, Cisco ASA). For each type, Oracle provides CPE configuration content that can help a network engineer configure the CPE. The OCID uniquely identifies the type of device. To get the OCIDs for the device types on the list, see listCpeDeviceShapes.

        For information about how to generate CPE configuration content for a CPE device type, see:

        getCpeDeviceConfigContent * getIpsecCpeDeviceConfigContent * getTunnelCpeDeviceConfigContent * getTunnelCpeDeviceConfig

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the CPE was created, in the format defined by RFC3339.

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

        Returns:
        the value

      • getIsPrivate

        public Boolean getIsPrivate()
        Indicates whether this CPE is of type private or not.
        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