com.oracle.bmc.core.model

Class Cpe

java.lang.Object

com.oracle.bmc.core.model.Cpe

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class Cpe
extends Object

An object you create when setting up an IPSec 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 IPSec VPN 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.cloud.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 __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cpe.Builder

Constructor Summary

Constructors

Constructor and Description
Cpe(String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String id, String ipAddress, String cpeDeviceShapeId, Date timeCreated) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Cpe.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getCompartmentId() The OCID of the compartment containing the CPE.
String	getCpeDeviceShapeId() The OCID of the CPE’s device type.
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDisplayName() A user-friendly name.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
String	getId() The CPE’s Oracle ID (OCID).
String	getIpAddress() The public IP address of the on-premises router.
Date	getTimeCreated() The date and time the CPE was created, in the format defined by RFC3339.
int	hashCode()
Cpe.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Cpe

@ConstructorProperties(value={"compartmentId","definedTags","displayName","freeformTags","id","ipAddress","cpeDeviceShapeId","timeCreated"})
 @Deprecated
public Cpe(String compartmentId,
                                                                                                                                                                     Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                     String displayName,
                                                                                                                                                                     Map<String,String> freeformTags,
                                                                                                                                                                     String id,
                                                                                                                                                                     String ipAddress,
                                                                                                                                                                     String cpeDeviceShapeId,
                                                                                                                                                                     Date timeCreated)

Deprecated.

Method Detail

builder

public static Cpe.Builder builder()

Create a new builder.

toBuilder

public Cpe.Builder toBuilder()

getCompartmentId

public String getCompartmentId()

The OCID of the compartment containing the CPE.

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

getDisplayName

public String getDisplayName()

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

getFreeformTags

public Map<String,String> getFreeformTags()

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

getId

public String getId()

The CPE’s Oracle ID (OCID).

getIpAddress

public String getIpAddress()

The public IP address of the on-premises router.

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

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`

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object