DatabaseConnectionStringProfile¶

class oci.database.models.DatabaseConnectionStringProfile(**kwargs)¶

Bases: object

The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.

Attributes

`CONSUMER_GROUP_HIGH`	A constant which can be used with the consumer_group property of a DatabaseConnectionStringProfile.
`CONSUMER_GROUP_LOW`	A constant which can be used with the consumer_group property of a DatabaseConnectionStringProfile.
`CONSUMER_GROUP_MEDIUM`	A constant which can be used with the consumer_group property of a DatabaseConnectionStringProfile.
`CONSUMER_GROUP_TP`	A constant which can be used with the consumer_group property of a DatabaseConnectionStringProfile.
`CONSUMER_GROUP_TPURGENT`	A constant which can be used with the consumer_group property of a DatabaseConnectionStringProfile.
`HOST_FORMAT_FQDN`	A constant which can be used with the host_format property of a DatabaseConnectionStringProfile.
`HOST_FORMAT_IP`	A constant which can be used with the host_format property of a DatabaseConnectionStringProfile.
`PROTOCOL_TCP`	A constant which can be used with the protocol property of a DatabaseConnectionStringProfile.
`PROTOCOL_TCPS`	A constant which can be used with the protocol property of a DatabaseConnectionStringProfile.
`SESSION_MODE_DIRECT`	A constant which can be used with the session_mode property of a DatabaseConnectionStringProfile.
`SESSION_MODE_REDIRECT`	A constant which can be used with the session_mode property of a DatabaseConnectionStringProfile.
`SYNTAX_FORMAT_EZCONNECT`	A constant which can be used with the syntax_format property of a DatabaseConnectionStringProfile.
`SYNTAX_FORMAT_EZCONNECTPLUS`	A constant which can be used with the syntax_format property of a DatabaseConnectionStringProfile.
`SYNTAX_FORMAT_LONG`	A constant which can be used with the syntax_format property of a DatabaseConnectionStringProfile.
`TLS_AUTHENTICATION_MUTUAL`	A constant which can be used with the tls_authentication property of a DatabaseConnectionStringProfile.
`TLS_AUTHENTICATION_SERVER`	A constant which can be used with the tls_authentication property of a DatabaseConnectionStringProfile.
`consumer_group`	Gets the consumer_group of this DatabaseConnectionStringProfile.
`display_name`	[Required] Gets the display_name of this DatabaseConnectionStringProfile.
`host_format`	[Required] Gets the host_format of this DatabaseConnectionStringProfile.
`is_regional`	Gets the is_regional of this DatabaseConnectionStringProfile.
`protocol`	[Required] Gets the protocol of this DatabaseConnectionStringProfile.
`session_mode`	[Required] Gets the session_mode of this DatabaseConnectionStringProfile.
`syntax_format`	[Required] Gets the syntax_format of this DatabaseConnectionStringProfile.
`tls_authentication`	Gets the tls_authentication of this DatabaseConnectionStringProfile.
`value`	[Required] Gets the value of this DatabaseConnectionStringProfile.

Methods

__init__(**kwargs) Initializes a new DatabaseConnectionStringProfile object with values from keyword arguments.

CONSUMER_GROUP_HIGH = 'HIGH'¶: A constant which can be used with the consumer_group property of a DatabaseConnectionStringProfile. This constant has a value of “HIGH”

CONSUMER_GROUP_LOW = 'LOW'¶: A constant which can be used with the consumer_group property of a DatabaseConnectionStringProfile. This constant has a value of “LOW”

CONSUMER_GROUP_MEDIUM = 'MEDIUM'¶: A constant which can be used with the consumer_group property of a DatabaseConnectionStringProfile. This constant has a value of “MEDIUM”

CONSUMER_GROUP_TP = 'TP'¶: A constant which can be used with the consumer_group property of a DatabaseConnectionStringProfile. This constant has a value of “TP”

CONSUMER_GROUP_TPURGENT = 'TPURGENT'¶: A constant which can be used with the consumer_group property of a DatabaseConnectionStringProfile. This constant has a value of “TPURGENT”

HOST_FORMAT_FQDN = 'FQDN'¶: A constant which can be used with the host_format property of a DatabaseConnectionStringProfile. This constant has a value of “FQDN”

HOST_FORMAT_IP = 'IP'¶: A constant which can be used with the host_format property of a DatabaseConnectionStringProfile. This constant has a value of “IP”

PROTOCOL_TCP = 'TCP'¶: A constant which can be used with the protocol property of a DatabaseConnectionStringProfile. This constant has a value of “TCP”

PROTOCOL_TCPS = 'TCPS'¶: A constant which can be used with the protocol property of a DatabaseConnectionStringProfile. This constant has a value of “TCPS”

SESSION_MODE_DIRECT = 'DIRECT'¶: A constant which can be used with the session_mode property of a DatabaseConnectionStringProfile. This constant has a value of “DIRECT”

SESSION_MODE_REDIRECT = 'REDIRECT'¶: A constant which can be used with the session_mode property of a DatabaseConnectionStringProfile. This constant has a value of “REDIRECT”

SYNTAX_FORMAT_EZCONNECT = 'EZCONNECT'¶: A constant which can be used with the syntax_format property of a DatabaseConnectionStringProfile. This constant has a value of “EZCONNECT”

SYNTAX_FORMAT_EZCONNECTPLUS = 'EZCONNECTPLUS'¶: A constant which can be used with the syntax_format property of a DatabaseConnectionStringProfile. This constant has a value of “EZCONNECTPLUS”

SYNTAX_FORMAT_LONG = 'LONG'¶: A constant which can be used with the syntax_format property of a DatabaseConnectionStringProfile. This constant has a value of “LONG”

TLS_AUTHENTICATION_MUTUAL = 'MUTUAL'¶: A constant which can be used with the tls_authentication property of a DatabaseConnectionStringProfile. This constant has a value of “MUTUAL”

TLS_AUTHENTICATION_SERVER = 'SERVER'¶: A constant which can be used with the tls_authentication property of a DatabaseConnectionStringProfile. This constant has a value of “SERVER”

__init__(**kwargs)¶

Initializes a new DatabaseConnectionStringProfile object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this DatabaseConnectionStringProfile.
value (str) – The value to assign to the value property of this DatabaseConnectionStringProfile.
consumer_group (str) – The value to assign to the consumer_group property of this DatabaseConnectionStringProfile. Allowed values for this property are: “HIGH”, “MEDIUM”, “LOW”, “TP”, “TPURGENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
protocol (str) – The value to assign to the protocol property of this DatabaseConnectionStringProfile. Allowed values for this property are: “TCP”, “TCPS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
tls_authentication (str) – The value to assign to the tls_authentication property of this DatabaseConnectionStringProfile. Allowed values for this property are: “SERVER”, “MUTUAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
host_format (str) – The value to assign to the host_format property of this DatabaseConnectionStringProfile. Allowed values for this property are: “FQDN”, “IP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
session_mode (str) – The value to assign to the session_mode property of this DatabaseConnectionStringProfile. Allowed values for this property are: “DIRECT”, “REDIRECT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
syntax_format (str) – The value to assign to the syntax_format property of this DatabaseConnectionStringProfile. Allowed values for this property are: “LONG”, “EZCONNECT”, “EZCONNECTPLUS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_regional (bool) – The value to assign to the is_regional property of this DatabaseConnectionStringProfile.

consumer_group¶

Gets the consumer_group of this DatabaseConnectionStringProfile. Consumer group used by the connection.

Allowed values for this property are: “HIGH”, “MEDIUM”, “LOW”, “TP”, “TPURGENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The consumer_group of this DatabaseConnectionStringProfile.
Return type:	str

display_name¶

[Required] Gets the display_name of this DatabaseConnectionStringProfile. A user-friendly name for the connection.

Returns:	The display_name of this DatabaseConnectionStringProfile.
Return type:	str

host_format¶

[Required] Gets the host_format of this DatabaseConnectionStringProfile. Host format used in connection string.

Allowed values for this property are: “FQDN”, “IP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The host_format of this DatabaseConnectionStringProfile.
Return type:	str

is_regional¶

Gets the is_regional of this DatabaseConnectionStringProfile. True for a regional connection string, applicable to cross-region DG only.

Returns:	The is_regional of this DatabaseConnectionStringProfile.
Return type:	bool

protocol¶

[Required] Gets the protocol of this DatabaseConnectionStringProfile. Protocol used by the connection.

Allowed values for this property are: “TCP”, “TCPS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The protocol of this DatabaseConnectionStringProfile.
Return type:	str

session_mode¶

[Required] Gets the session_mode of this DatabaseConnectionStringProfile. Specifies whether the listener performs a direct hand-off of the session, or redirects the session. In RAC deployments where SCAN is used, sessions are redirected to a Node VIP. Use DIRECT for direct hand-offs. Use REDIRECT to redirect the session.

Allowed values for this property are: “DIRECT”, “REDIRECT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The session_mode of this DatabaseConnectionStringProfile.
Return type:	str

syntax_format¶

[Required] Gets the syntax_format of this DatabaseConnectionStringProfile. Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format. Autonomous Database Serverless instances always use the long format.

Allowed values for this property are: “LONG”, “EZCONNECT”, “EZCONNECTPLUS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The syntax_format of this DatabaseConnectionStringProfile.
Return type:	str

tls_authentication¶

Gets the tls_authentication of this DatabaseConnectionStringProfile. Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication.

Allowed values for this property are: “SERVER”, “MUTUAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The tls_authentication of this DatabaseConnectionStringProfile.
Return type:	str

value¶

[Required] Gets the value of this DatabaseConnectionStringProfile. Connection string value.

Returns:	The value of this DatabaseConnectionStringProfile.
Return type:	str