Package com.oracle.bmc.goldengate.model

Class OracleConnectionSummary

java.lang.Object

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

com.oracle.bmc.goldengate.model.ConnectionSummary

com.oracle.bmc.goldengate.model.OracleConnectionSummary

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

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

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

OracleConnectionSummary(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, String vaultId, String keyId, List<IngressIpDetails> ingressIps, List<String> nsgIds, String subnetId, RoutingMethod routingMethod, List<ResourceLock> locks, 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 OracleConnectionSummary.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()	This property is not available when creating connections.
OracleConnection.SessionMode	getSessionMode()	Specifies the session mode for the database connection.
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()
OracleConnectionSummary.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

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

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

OracleConnectionSummary

@Deprecated
public OracleConnectionSummary(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,
                               String vaultId,
                               String keyId,
                               List<IngressIpDetails> ingressIps,
                               List<String> nsgIds,
                               String subnetId,
                               RoutingMethod routingMethod,
                               List<ResourceLock> locks,
                               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 OracleConnectionSummary.Builder builder()

Create a new builder.

toBuilder

public OracleConnectionSummary.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()

Specifies the session mode for the database connection.

Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners.

The default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener. In this case, the default is REDIRECT.

Deprecated: Defaulting to the REDIRECT session mode will be removed after March 1, 2027.

Returns:

the value

getPrivateIp

public String getPrivateIp()

This property is not available when creating connections.

For existing deprecated connections having this value set, the value cannot be updated; set it to empty.

For deprecated connections created with this field in the past, either the private IP had to be specified in the connectionString or host field, or the host name had to be resolvable in the target VCN.

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 ConnectionSummary

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class ConnectionSummary

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class ConnectionSummary

hashCode

public int hashCode()

Overrides:

hashCode in class ConnectionSummary