Package com.oracle.bmc.goldengate.model

Class CreateMicrosoftSqlserverConnectionDetails

java.lang.Object

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

com.oracle.bmc.goldengate.model.CreateConnectionDetails

com.oracle.bmc.goldengate.model.CreateMicrosoftSqlserverConnectionDetails

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

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

CreateMicrosoftSqlserverConnectionDetails(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, MicrosoftSqlserverConnection.TechnologyType technologyType, String databaseName, String host, Integer port, String username, String password, String passwordSecretId, List<NameValuePair> additionalAttributes, MicrosoftSqlserverConnection.SecurityProtocol securityProtocol, String sslCa, Boolean shouldValidateServerCertificate, String privateIp)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static CreateMicrosoftSqlserverConnectionDetails.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 Microsoft SQL Server.
String	getPasswordSecretId()	The OCID of the Secret that stores the password Oracle GoldenGate uses to connect the associated Microsoft SQL Server.
Integer	getPort()	The port of an endpoint usually specified for a connection.
String	getPrivateIp()	Deprecated: this field will be removed in future versions.
MicrosoftSqlserverConnection.SecurityProtocol	getSecurityProtocol()	Security Type for Microsoft SQL Server.
Boolean	getShouldValidateServerCertificate()	If set to true, the driver validates the certificate that is sent by the database server.
String	getSslCa()	Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).
MicrosoftSqlserverConnection.TechnologyType	getTechnologyType()	The Microsoft SQL Server technology type.
String	getUsername()	The username Oracle GoldenGate uses to connect to the Microsoft SQL Server.
int	hashCode()
CreateMicrosoftSqlserverConnectionDetails.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

CreateMicrosoftSqlserverConnectionDetails

@Deprecated
public CreateMicrosoftSqlserverConnectionDetails(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,
                                                 MicrosoftSqlserverConnection.TechnologyType technologyType,
                                                 String databaseName,
                                                 String host,
                                                 Integer port,
                                                 String username,
                                                 String password,
                                                 String passwordSecretId,
                                                 List<NameValuePair> additionalAttributes,
                                                 MicrosoftSqlserverConnection.SecurityProtocol securityProtocol,
                                                 String sslCa,
                                                 Boolean shouldValidateServerCertificate,
                                                 String privateIp)

Deprecated.

Method Detail

builder

public static CreateMicrosoftSqlserverConnectionDetails.Builder builder()

Create a new builder.

toBuilder

public CreateMicrosoftSqlserverConnectionDetails.Builder toBuilder()

getTechnologyType

public MicrosoftSqlserverConnection.TechnologyType getTechnologyType()

The Microsoft SQL Server 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 Microsoft SQL Server.

This username must already exist and be available by the Microsoft SQL Server to be connected to.

Returns:

the value

getPassword

public String getPassword()

The password Oracle GoldenGate uses to connect the associated Microsoft SQL Server.

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 that stores the password Oracle GoldenGate uses to connect the associated Microsoft SQL Server.

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 MicrosoftSqlserverConnection.SecurityProtocol getSecurityProtocol()

Security Type for Microsoft SQL Server.

Returns:

the value

getSslCa

public String getSslCa()

Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).

Returns:

the value

getShouldValidateServerCertificate

public Boolean getShouldValidateServerCertificate()

If set to true, the driver validates the certificate that is sent by the database server.

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

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