Package com.oracle.bmc.goldengate.model

Class PostgresqlConnection

java.lang.Object

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

com.oracle.bmc.goldengate.model.Connection

com.oracle.bmc.goldengate.model.PostgresqlConnection

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

Represents the metadata of a PostgreSQL Database Connection.
Note: Objects should always be created or deserialized using the PostgresqlConnection.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 PostgresqlConnection.Builder, which maintain a set of all explicitly set fields called PostgresqlConnection.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	PostgresqlConnection.Builder
static class	PostgresqlConnection.SecurityProtocol	Security protocol for PostgreSQL.
static class	PostgresqlConnection.SslMode	SSL mode for PostgreSQL.
static class	PostgresqlConnection.TechnologyType	The PostgreSQL technology type.

Nested classes/interfaces inherited from class com.oracle.bmc.goldengate.model.Connection

Connection.LifecycleState

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

PostgresqlConnection(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, List<ResourceLock> locks, String vaultId, String keyId, List<IngressIpDetails> ingressIps, List<String> nsgIds, String subnetId, RoutingMethod routingMethod, Boolean doesUseSecretIds, String subscriptionId, String clusterPlacementGroupId, Map<String,Map<String,Object>> securityAttributes, PostgresqlConnection.TechnologyType technologyType, String databaseName, String host, Integer port, String username, List<NameValuePair> additionalAttributes, PostgresqlConnection.SecurityProtocol securityProtocol, PostgresqlConnection.SslMode sslMode, String privateIp, String dbSystemId, String passwordSecretId, String sslKeySecretId, String sslCa, String sslCrl, String sslCert)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static PostgresqlConnection.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	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.
PostgresqlConnection.SecurityProtocol	getSecurityProtocol()	Security protocol for PostgreSQL.
String	getSslCa()	The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL.
String	getSslCert()	The base64 encoded certificate of the PostgreSQL server.
String	getSslCrl()	The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).
String	getSslKeySecretId()	The OCID of the Secret that stores the private key of the PostgreSQL server.
PostgresqlConnection.SslMode	getSslMode()	SSL mode for PostgreSQL.
PostgresqlConnection.TechnologyType	getTechnologyType()	The PostgreSQL technology type.
String	getUsername()	The username Oracle GoldenGate uses to connect the associated system of the given technology.
int	hashCode()
PostgresqlConnection.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

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

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

PostgresqlConnection

@Deprecated
public PostgresqlConnection(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,
                            List<ResourceLock> locks,
                            String vaultId,
                            String keyId,
                            List<IngressIpDetails> ingressIps,
                            List<String> nsgIds,
                            String subnetId,
                            RoutingMethod routingMethod,
                            Boolean doesUseSecretIds,
                            String subscriptionId,
                            String clusterPlacementGroupId,
                            Map<String,Map<String,Object>> securityAttributes,
                            PostgresqlConnection.TechnologyType technologyType,
                            String databaseName,
                            String host,
                            Integer port,
                            String username,
                            List<NameValuePair> additionalAttributes,
                            PostgresqlConnection.SecurityProtocol securityProtocol,
                            PostgresqlConnection.SslMode sslMode,
                            String privateIp,
                            String dbSystemId,
                            String passwordSecretId,
                            String sslKeySecretId,
                            String sslCa,
                            String sslCrl,
                            String sslCert)

Deprecated.

Method Detail

builder

public static PostgresqlConnection.Builder builder()

Create a new builder.

toBuilder

public PostgresqlConnection.Builder toBuilder()

getTechnologyType

public PostgresqlConnection.TechnologyType getTechnologyType()

The PostgreSQL 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 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

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

Security protocol for PostgreSQL.

Returns:

the value

getSslMode

public PostgresqlConnection.SslMode getSslMode()

SSL mode for PostgreSQL.

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

getDbSystemId

public String getDbSystemId()

The OCID of the database system 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

getSslKeySecretId

public String getSslKeySecretId()

The OCID of the Secret that stores the private key of the PostgreSQL server.

The supported file formats are .pem and .crt. Note: When provided, ‘sslKey’ field must not be provided.

Returns:

the value

getSslCa

public String getSslCa()

The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL.

The supported file formats are .pem and .crt. It is not included in GET responses if the view=COMPACT query parameter is specified.

Returns:

the value

getSslCrl

public String getSslCrl()

The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).

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

Returns:

the value

getSslCert

public String getSslCert()

The base64 encoded certificate of the PostgreSQL server.

The supported file formats are .pem and .crt. 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 Connection

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class Connection

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class Connection

hashCode

public int hashCode()

Overrides:

hashCode in class Connection