Record Class DatabaseSpec.DatabaseConnection

java.lang.Object

java.lang.Record

com.cloudforge.core.interfaces.DatabaseSpec.DatabaseConnection

Record Components:

endpoint - the database endpoint hostname

port - the database port number

databaseName - the name of the database

username - the database username

passwordSecretArn - the ARN of the secret containing the database password

engine - the database engine type

version - the database engine version

readReplicaEndpoints - list of read replica endpoints (if any)

Enclosing interface:

DatabaseSpec

public static record DatabaseSpec.DatabaseConnection(String endpoint, int port, String databaseName, String username, String passwordSecretArn, String engine, String version, List<String> readReplicaEndpoints)
extends Record

Database connection information provided to applications.

Since:

3.0.0

Constructor Summary

Constructors

Constructor	Description
DatabaseConnection(String endpoint, int port, String databaseName, String username, String passwordSecretArn, String engine, String version, List<String> readReplicaEndpoints)	Creates an instance of a DatabaseConnection record class.

Method Summary

Modifier and Type	Method	Description
String	databaseName()	Returns the value of the databaseName record component.
String	endpoint()	Returns the value of the endpoint record component.
String	engine()	Returns the value of the engine record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	hasReadReplicas()
String	passwordSecretArn()	Returns the value of the passwordSecretArn record component.
int	port()	Returns the value of the port record component.
List<String>	readReplicaEndpoints()	Returns the value of the readReplicaEndpoints record component.
final String	toString()	Returns a string representation of this record class.
String	username()	Returns the value of the username record component.
String	version()	Returns the value of the version record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DatabaseConnection

public DatabaseConnection(String endpoint,
 int port,
 String databaseName,
 String username,
 String passwordSecretArn,
 String engine,
 String version,
 List<String> readReplicaEndpoints)

Creates an instance of a DatabaseConnection record class.

Parameters:

endpoint - the value for the endpoint record component

port - the value for the port record component

databaseName - the value for the databaseName record component

username - the value for the username record component

passwordSecretArn - the value for the passwordSecretArn record component

engine - the value for the engine record component

version - the value for the version record component

readReplicaEndpoints - the value for the readReplicaEndpoints record component

Method Details

hasReadReplicas

public boolean hasReadReplicas()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

endpoint

public String endpoint()

Returns the value of the endpoint record component.

Returns:

the value of the endpoint record component

port

public int port()

Returns the value of the port record component.

Returns:

the value of the port record component

databaseName

public String databaseName()

Returns the value of the databaseName record component.

Returns:

the value of the databaseName record component

username

public String username()

Returns the value of the username record component.

Returns:

the value of the username record component

passwordSecretArn

public String passwordSecretArn()

Returns the value of the passwordSecretArn record component.

Returns:

the value of the passwordSecretArn record component

engine

public String engine()

Returns the value of the engine record component.

Returns:

the value of the engine record component

version

public String version()

Returns the value of the version record component.

Returns:

the value of the version record component

readReplicaEndpoints

public List<String> readReplicaEndpoints()

Returns the value of the readReplicaEndpoints record component.

Returns:

the value of the readReplicaEndpoints record component