Package com.oracle.bmc.goldengate.model

Class OracleConnection.Builder

java.lang.Object

com.oracle.bmc.goldengate.model.OracleConnection.Builder

Enclosing class:

OracleConnection

public static class OracleConnection.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OracleConnection.Builder	authenticationMode(OracleConnection.AuthenticationMode authenticationMode)	Authentication mode.
OracleConnection	build()
OracleConnection.Builder	compartmentId(String compartmentId)
OracleConnection.Builder	connectionString(String connectionString)	Connect descriptor or Easy Connect Naming method used to connect to a database.
OracleConnection.Builder	copy(OracleConnection model)
OracleConnection.Builder	databaseId(String databaseId)	The OCID of the database being referenced.
OracleConnection.Builder	definedTags(Map<String,Map<String,Object>> definedTags)
OracleConnection.Builder	description(String description)
OracleConnection.Builder	displayName(String displayName)
OracleConnection.Builder	doesUseSecretIds(Boolean doesUseSecretIds)
OracleConnection.Builder	freeformTags(Map<String,String> freeformTags)
OracleConnection.Builder	id(String id)
OracleConnection.Builder	ingressIps(List<IngressIpDetails> ingressIps)
OracleConnection.Builder	keyId(String keyId)
OracleConnection.Builder	lifecycleDetails(String lifecycleDetails)
OracleConnection.Builder	lifecycleState(Connection.LifecycleState lifecycleState)
OracleConnection.Builder	locks(List<ResourceLock> locks)
OracleConnection.Builder	nsgIds(List<String> nsgIds)
OracleConnection.Builder	passwordSecretId(String passwordSecretId)	The OCID of the Secret where the password is stored.
OracleConnection.Builder	privateIp(String privateIp)	Deprecated: this field will be removed in future versions.
OracleConnection.Builder	routingMethod(RoutingMethod routingMethod)
OracleConnection.Builder	sessionMode(OracleConnection.SessionMode sessionMode)	The mode of the database connection session to be established by the data client.
OracleConnection.Builder	subnetId(String subnetId)
OracleConnection.Builder	systemTags(Map<String,Map<String,Object>> systemTags)
OracleConnection.Builder	technologyType(OracleConnection.TechnologyType technologyType)	The Oracle technology type.
OracleConnection.Builder	timeCreated(Date timeCreated)
OracleConnection.Builder	timeUpdated(Date timeUpdated)
OracleConnection.Builder	username(String username)	The username Oracle GoldenGate uses to connect the associated system of the given technology.
OracleConnection.Builder	vaultId(String vaultId)
OracleConnection.Builder	walletSecretId(String walletSecretId)	The OCID of the Secret where the wallet file is stored.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

id

public OracleConnection.Builder id(String id)

displayName

public OracleConnection.Builder displayName(String displayName)

description

public OracleConnection.Builder description(String description)

compartmentId

public OracleConnection.Builder compartmentId(String compartmentId)

freeformTags

public OracleConnection.Builder freeformTags(Map<String,String> freeformTags)

definedTags

public OracleConnection.Builder definedTags(Map<String,Map<String,Object>> definedTags)

systemTags

public OracleConnection.Builder systemTags(Map<String,Map<String,Object>> systemTags)

lifecycleState

public OracleConnection.Builder lifecycleState(Connection.LifecycleState lifecycleState)

lifecycleDetails

public OracleConnection.Builder lifecycleDetails(String lifecycleDetails)

timeCreated

public OracleConnection.Builder timeCreated(Date timeCreated)

timeUpdated

public OracleConnection.Builder timeUpdated(Date timeUpdated)

locks

public OracleConnection.Builder locks(List<ResourceLock> locks)

vaultId

public OracleConnection.Builder vaultId(String vaultId)

keyId

public OracleConnection.Builder keyId(String keyId)

ingressIps

public OracleConnection.Builder ingressIps(List<IngressIpDetails> ingressIps)

nsgIds

public OracleConnection.Builder nsgIds(List<String> nsgIds)

subnetId

public OracleConnection.Builder subnetId(String subnetId)

routingMethod

public OracleConnection.Builder routingMethod(RoutingMethod routingMethod)

doesUseSecretIds

public OracleConnection.Builder doesUseSecretIds(Boolean doesUseSecretIds)

technologyType

public OracleConnection.Builder technologyType(OracleConnection.TechnologyType technologyType)

The Oracle technology type.

Parameters:

technologyType - the value to set

Returns:

this builder

username

public OracleConnection.Builder username(String username)

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.

Parameters:

username - the value to set

Returns:

this builder

connectionString

public OracleConnection.Builder connectionString(String connectionString)

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

Parameters:

connectionString - the value to set

Returns:

this builder

authenticationMode

public OracleConnection.Builder authenticationMode(OracleConnection.AuthenticationMode authenticationMode)

Authentication mode.

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

Parameters:

authenticationMode - the value to set

Returns:

this builder

sessionMode

public OracleConnection.Builder sessionMode(OracleConnection.SessionMode sessionMode)

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.

Parameters:

sessionMode - the value to set

Returns:

this builder

privateIp

public OracleConnection.Builder privateIp(String privateIp)

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.

Parameters:

privateIp - the value to set

Returns:

this builder

databaseId

public OracleConnection.Builder databaseId(String databaseId)

The OCID of the database being referenced.

Parameters:

databaseId - the value to set

Returns:

this builder

passwordSecretId

public OracleConnection.Builder passwordSecretId(String passwordSecretId)

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.

Parameters:

passwordSecretId - the value to set

Returns:

this builder

walletSecretId

public OracleConnection.Builder walletSecretId(String walletSecretId)

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.

Parameters:

walletSecretId - the value to set

Returns:

this builder

build

public OracleConnection build()

copy

public OracleConnection.Builder copy(OracleConnection model)