Package com.oracle.bmc.goldengate.model

Class CreateDb2ConnectionDetails

java.lang.Object

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

com.oracle.bmc.goldengate.model.CreateConnectionDetails

com.oracle.bmc.goldengate.model.CreateDb2ConnectionDetails

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

The information about a new DB2 Connection.
Note: Objects should always be created or deserialized using the CreateDb2ConnectionDetails.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 CreateDb2ConnectionDetails.Builder, which maintain a set of all explicitly set fields called CreateDb2ConnectionDetails.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	CreateDb2ConnectionDetails.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

CreateDb2ConnectionDetails(String displayName, String description, String compartmentId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, List<AddResourceLockDetails> locks, String vaultId, String keyId, List<String> nsgIds, String subnetId, RoutingMethod routingMethod, Boolean doesUseSecretIds, String subscriptionId, String clusterPlacementGroupId, Map<String,Map<String,Object>> securityAttributes, Db2Connection.TechnologyType technologyType, String databaseName, String host, Integer port, String username, String password, String passwordSecretId, List<NameValuePair> additionalAttributes, Db2Connection.SecurityProtocol securityProtocol, String sslClientKeystoredb, String sslClientKeystoredbSecretId, String sslClientKeystash, String sslClientKeystashSecretId, String sslServerCertificate)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static CreateDb2ConnectionDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<NameValuePair>	getAdditionalAttributes()	An array of name-value pair attribute entries.
String	getDatabaseName()	The name of the database.
String	getHost()	The name or address of a host.
String	getPassword()	The password Oracle GoldenGate uses to connect the associated DB2 database.
String	getPasswordSecretId()	The OCID of the Secret where the password is stored, that Oracle GoldenGate uses to connect the associated DB2 database.
Integer	getPort()	The port of an endpoint usually specified for a connection.
Db2Connection.SecurityProtocol	getSecurityProtocol()	Security protocol for the DB2 database.
String	getSslClientKeystash()	The base64 encoded keystash file which contains the encrypted password to the key database file.
String	getSslClientKeystashSecretId()	The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file.
String	getSslClientKeystoredb()	The base64 encoded keystore file created at the client containing the server certificate / CA root certificate.
String	getSslClientKeystoredbSecretId()	The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate.
String	getSslServerCertificate()	The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.
Db2Connection.TechnologyType	getTechnologyType()	The DB2 technology type.
String	getUsername()	The username Oracle GoldenGate uses to connect to the DB2 database.
int	hashCode()
CreateDb2ConnectionDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

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

getClusterPlacementGroupId, getCompartmentId, getDefinedTags, getDescription, getDisplayName, getDoesUseSecretIds, getFreeformTags, getKeyId, getLocks, getNsgIds, getRoutingMethod, getSecurityAttributes, getSubnetId, getSubscriptionId, 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

CreateDb2ConnectionDetails

@Deprecated
public CreateDb2ConnectionDetails(String displayName,
                                  String description,
                                  String compartmentId,
                                  Map<String,String> freeformTags,
                                  Map<String,Map<String,Object>> definedTags,
                                  List<AddResourceLockDetails> locks,
                                  String vaultId,
                                  String keyId,
                                  List<String> nsgIds,
                                  String subnetId,
                                  RoutingMethod routingMethod,
                                  Boolean doesUseSecretIds,
                                  String subscriptionId,
                                  String clusterPlacementGroupId,
                                  Map<String,Map<String,Object>> securityAttributes,
                                  Db2Connection.TechnologyType technologyType,
                                  String databaseName,
                                  String host,
                                  Integer port,
                                  String username,
                                  String password,
                                  String passwordSecretId,
                                  List<NameValuePair> additionalAttributes,
                                  Db2Connection.SecurityProtocol securityProtocol,
                                  String sslClientKeystoredb,
                                  String sslClientKeystoredbSecretId,
                                  String sslClientKeystash,
                                  String sslClientKeystashSecretId,
                                  String sslServerCertificate)

Deprecated.

Method Detail

builder

public static CreateDb2ConnectionDetails.Builder builder()

Create a new builder.

toBuilder

public CreateDb2ConnectionDetails.Builder toBuilder()

getTechnologyType

public Db2Connection.TechnologyType getTechnologyType()

The DB2 technology type.

Returns:

the value

getDatabaseName

public String getDatabaseName()

The name of the database.

Returns:

the value

getHost

public String getHost()

The name or address of a host.

Returns:

the value

getPort

public Integer getPort()

The port of an endpoint usually specified for a connection.

Returns:

the value

getUsername

public String getUsername()

The username Oracle GoldenGate uses to connect to the DB2 database.

This username must already exist and be available by the DB2 to be connected to.

Returns:

the value

getPassword

public String getPassword()

The password Oracle GoldenGate uses to connect the associated DB2 database.

Deprecated: This field is deprecated and replaced by “passwordSecretId”. This field will be removed after February 15 2026.

Returns:

the value

getPasswordSecretId

public String getPasswordSecretId()

The OCID of the Secret where the password is stored, that Oracle GoldenGate uses to connect the associated DB2 database.

Note: When provided, ‘password’ field must not be provided.

Returns:

the value

getAdditionalAttributes

public List<NameValuePair> getAdditionalAttributes()

An array of name-value pair attribute entries.

Used as additional parameters in connection string.

Returns:

the value

getSecurityProtocol

public Db2Connection.SecurityProtocol getSecurityProtocol()

Security protocol for the DB2 database.

Returns:

the value

getSslClientKeystoredb

public String getSslClientKeystoredb()

The base64 encoded keystore file created at the client containing the server certificate / CA root certificate.

This property is not supported for IBM Db2 for i, as client TLS mode is not available.

Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.

Returns:

the value

getSslClientKeystoredbSecretId

public String getSslClientKeystoredbSecretId()

The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate.

This property is not supported for IBM Db2 for i, as client TLS mode is not available.

Note: When provided, 'sslClientKeystoredb' field must not be provided.

Returns:

the value

getSslClientKeystash

public String getSslClientKeystash()

The base64 encoded keystash file which contains the encrypted password to the key database file.

This property is not supported for IBM Db2 for i, as client TLS mode is not available.

Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.

Returns:

the value

getSslClientKeystashSecretId

public String getSslClientKeystashSecretId()

The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file.

This property is not supported for IBM Db2 for i, as client TLS mode is not available.

Note: When provided, 'sslClientKeystash' field must not be provided.

Returns:

the value

getSslServerCertificate

public String getSslServerCertificate()

The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.

It is not included in GET responses if the view=COMPACT query parameter is specified.

Returns:

the value

toString

public String toString()

Overrides:

toString in class CreateConnectionDetails

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class CreateConnectionDetails

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class CreateConnectionDetails

hashCode

public int hashCode()

Overrides:

hashCode in class CreateConnectionDetails