com.oracle.bmc.goldengate.model

Class UpdateMysqlConnectionDetails

java.lang.Object

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

com.oracle.bmc.goldengate.model.UpdateConnectionDetails

com.oracle.bmc.goldengate.model.UpdateMysqlConnectionDetails

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

The information to update a MySQL Connection.
Note: Objects should always be created or deserialized using the UpdateMysqlConnectionDetails.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 UpdateMysqlConnectionDetails.Builder, which maintain a set of all explicitly set fields called UpdateMysqlConnectionDetails.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 and Description
static class	UpdateMysqlConnectionDetails.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 and Description

UpdateMysqlConnectionDetails(String displayName, String description, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, String vaultId, String keyId, List<String> nsgIds, String subnetId, RoutingMethod routingMethod, Boolean doesUseSecretIds, String username, String password, String passwordSecretId, String host, Integer port, String databaseName, MysqlConnection.SecurityProtocol securityProtocol, MysqlConnection.SslMode sslMode, String sslCa, String sslCrl, String sslCert, String sslKey, String sslKeySecretId, String privateIp, List<NameValuePair> additionalAttributes, String dbSystemId) Deprecated.

Method Summary

Modifier and Type	Method and Description
static UpdateMysqlConnectionDetails.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	getDbSystemId() The OCID of the database system being referenced.
String	getHost() The name or address of a host.
String	getPassword() The password Oracle GoldenGate uses to connect the associated system of the given technology.
String	getPasswordSecretId() The OCID of the Secret where the password is stored.
Integer	getPort() The port of an endpoint usually specified for a connection.
String	getPrivateIp() Deprecated: this field will be removed in future versions.
MysqlConnection.SecurityProtocol	getSecurityProtocol() Security Type for MySQL.
String	getSslCa() Database Certificate - The base64 encoded content of a .pem or .crt file.
String	getSslCert() Client Certificate - The base64 encoded content of a .pem or .crt file.
String	getSslCrl() The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).
String	getSslKey() Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL).
String	getSslKeySecretId() The OCID of the Secret that stores the Client Key - The content of a .pem or .crt file containing the client private key (for 2-way SSL).
MysqlConnection.SslMode	getSslMode() SSL modes for MySQL.
String	getUsername() The username Oracle GoldenGate uses to connect the associated system of the given technology.
int	hashCode()
UpdateMysqlConnectionDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

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

getDefinedTags, getDescription, getDisplayName, getDoesUseSecretIds, getFreeformTags, getKeyId, getNsgIds, getRoutingMethod, getSubnetId, 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

UpdateMysqlConnectionDetails

@Deprecated
public UpdateMysqlConnectionDetails(String displayName,
                                                String description,
                                                Map<String,String> freeformTags,
                                                Map<String,Map<String,Object>> definedTags,
                                                String vaultId,
                                                String keyId,
                                                List<String> nsgIds,
                                                String subnetId,
                                                RoutingMethod routingMethod,
                                                Boolean doesUseSecretIds,
                                                String username,
                                                String password,
                                                String passwordSecretId,
                                                String host,
                                                Integer port,
                                                String databaseName,
                                                MysqlConnection.SecurityProtocol securityProtocol,
                                                MysqlConnection.SslMode sslMode,
                                                String sslCa,
                                                String sslCrl,
                                                String sslCert,
                                                String sslKey,
                                                String sslKeySecretId,
                                                String privateIp,
                                                List<NameValuePair> additionalAttributes,
                                                String dbSystemId)

Deprecated.

Method Detail

builder

public static UpdateMysqlConnectionDetails.Builder builder()

Create a new builder.

toBuilder

public UpdateMysqlConnectionDetails.Builder toBuilder()

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

getPassword

public String getPassword()

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.

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

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

getDatabaseName

public String getDatabaseName()

The name of the database.

Returns:

the value

getSecurityProtocol

public MysqlConnection.SecurityProtocol getSecurityProtocol()

Security Type for MySQL.

Returns:

the value

getSslMode

public MysqlConnection.SslMode getSslMode()

SSL modes for MySQL.

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 and 2-way SSL).

Returns:

the value

getSslCrl

public String getSslCrl()

The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected.

Returns:

the value

getSslCert

public String getSslCert()

Client Certificate - The base64 encoded content of a .pem or .crt file. containing the client public key (for 2-way SSL).

Returns:

the value

getSslKey

public String getSslKey()

Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL).

Returns:

the value

getSslKeySecretId

public String getSslKeySecretId()

The OCID of the Secret that stores the Client Key - The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, ‘sslKey’ field must not be provided.

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

getAdditionalAttributes

public List<NameValuePair> getAdditionalAttributes()

An array of name-value pair attribute entries. Used as additional parameters in connection string.

Returns:

the value

getDbSystemId

public String getDbSystemId()

The OCID of the database system being referenced.

Returns:

the value

toString

public String toString()

Overrides:

toString in class UpdateConnectionDetails

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class UpdateConnectionDetails

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class UpdateConnectionDetails

hashCode

public int hashCode()

Overrides:

hashCode in class UpdateConnectionDetails