Package com.oracle.bmc.goldengate.model

Class OracleConnection

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.goldengate.model.Connection

com.oracle.bmc.goldengate.model.OracleConnection

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200407")
public final class OracleConnection
extends Connection

Represents the metadata of an Oracle Database Connection.
Note: Objects should always be created or deserialized using the OracleConnection.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 OracleConnection.Builder, which maintain a set of all explicitly set fields called OracleConnection.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OracleConnection.AuthenticationMode	Authentication mode.
static class	OracleConnection.Builder
static class	OracleConnection.SessionMode	The mode of the database connection session to be established by the data client.
static class	OracleConnection.TechnologyType	The Oracle technology type.

Nested classes/interfaces inherited from class com.oracle.bmc.goldengate.model.Connection

Connection.LifecycleState

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

OracleConnection(String id, String displayName, String description, String compartmentId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, Connection.LifecycleState lifecycleState, String lifecycleDetails, Date timeCreated, Date timeUpdated, List<ResourceLock> locks, String vaultId, String keyId, List<IngressIpDetails> ingressIps, List<String> nsgIds, String subnetId, RoutingMethod routingMethod, Boolean doesUseSecretIds, String subscriptionId, String clusterPlacementGroupId, Map<String,Map<String,Object>> securityAttributes, OracleConnection.TechnologyType technologyType, String username, String connectionString, OracleConnection.AuthenticationMode authenticationMode, OracleConnection.SessionMode sessionMode, String privateIp, String databaseId, String passwordSecretId, String walletSecretId)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static OracleConnection.Builder	builder()	Create a new builder.
boolean	equals(Object o)
OracleConnection.AuthenticationMode	getAuthenticationMode()	Authentication mode.
String	getConnectionString()	Connect descriptor or Easy Connect Naming method used to connect to a database.
String	getDatabaseId()	The OCID of the database being referenced.
String	getPasswordSecretId()	The OCID of the Secret where the password is stored.
String	getPrivateIp()	Deprecated: this field will be removed in future versions.
OracleConnection.SessionMode	getSessionMode()	The mode of the database connection session to be established by the data client.
OracleConnection.TechnologyType	getTechnologyType()	The Oracle technology type.
String	getUsername()	The username Oracle GoldenGate uses to connect the associated system of the given technology.
String	getWalletSecretId()	The OCID of the Secret where the wallet file is stored.
int	hashCode()
OracleConnection.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.goldengate.model.Connection

getClusterPlacementGroupId, getCompartmentId, getDefinedTags, getDescription, getDisplayName, getDoesUseSecretIds, getFreeformTags, getId, getIngressIps, getKeyId, getLifecycleDetails, getLifecycleState, getLocks, getNsgIds, getRoutingMethod, getSecurityAttributes, getSubnetId, getSubscriptionId, getSystemTags, getTimeCreated, getTimeUpdated, getVaultId

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

OracleConnection

@Deprecated
public OracleConnection(String id,
                        String displayName,
                        String description,
                        String compartmentId,
                        Map<String,String> freeformTags,
                        Map<String,Map<String,Object>> definedTags,
                        Map<String,Map<String,Object>> systemTags,
                        Connection.LifecycleState lifecycleState,
                        String lifecycleDetails,
                        Date timeCreated,
                        Date timeUpdated,
                        List<ResourceLock> locks,
                        String vaultId,
                        String keyId,
                        List<IngressIpDetails> ingressIps,
                        List<String> nsgIds,
                        String subnetId,
                        RoutingMethod routingMethod,
                        Boolean doesUseSecretIds,
                        String subscriptionId,
                        String clusterPlacementGroupId,
                        Map<String,Map<String,Object>> securityAttributes,
                        OracleConnection.TechnologyType technologyType,
                        String username,
                        String connectionString,
                        OracleConnection.AuthenticationMode authenticationMode,
                        OracleConnection.SessionMode sessionMode,
                        String privateIp,
                        String databaseId,
                        String passwordSecretId,
                        String walletSecretId)

Deprecated.

Method Detail

builder

public static OracleConnection.Builder builder()

Create a new builder.

toBuilder

public OracleConnection.Builder toBuilder()

getTechnologyType

public OracleConnection.TechnologyType getTechnologyType()

The Oracle technology type.

Returns:

the value

getUsername

public String getUsername()

The username Oracle GoldenGate uses to connect the associated system of the given technology.

This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.

Returns:

the value

getConnectionString

public String getConnectionString()

Connect descriptor or Easy Connect Naming method used to connect to a database.

Returns:

the value

getAuthenticationMode

public OracleConnection.AuthenticationMode getAuthenticationMode()

Authentication mode.

It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.

Returns:

the value

getSessionMode

public OracleConnection.SessionMode getSessionMode()

The mode of the database connection session to be established by the data client.

‘REDIRECT’

• for a RAC database, ‘DIRECT’ - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

Returns:

the value

getPrivateIp

public String getPrivateIp()

Deprecated: this field will be removed in future versions.

Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.

The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

Returns:

the value

getDatabaseId

public String getDatabaseId()

The OCID of the database being referenced.

Returns:

the value

getPasswordSecretId

public String getPasswordSecretId()

The OCID of the Secret where the password is stored.

The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, ‘password’ field must not be provided.

Returns:

the value

getWalletSecretId

public String getWalletSecretId()

The OCID of the Secret where the wallet file is stored.

The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, ‘wallet’ field must not be provided.

Returns:

the value

toString

public String toString()

Overrides:

toString in class Connection

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class Connection

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class Connection

hashCode

public int hashCode()

Overrides:

hashCode in class Connection