DatabaseToolsConnectionPostgresqlSummary¶

class oci.database_tools.models.DatabaseToolsConnectionPostgresqlSummary(**kwargs)¶

Bases: DatabaseToolsConnectionSummary

Database Tools connection summary of a PostgreSQL Server.

Attributes:

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DatabaseToolsConnectionSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DatabaseToolsConnectionSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DatabaseToolsConnectionSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DatabaseToolsConnectionSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DatabaseToolsConnectionSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a DatabaseToolsConnectionSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DatabaseToolsConnectionSummary.
`RUNTIME_IDENTITY_AUTHENTICATED_PRINCIPAL`	A constant which can be used with the runtime_identity property of a DatabaseToolsConnectionSummary.
`RUNTIME_IDENTITY_RESOURCE_PRINCIPAL`	A constant which can be used with the runtime_identity property of a DatabaseToolsConnectionSummary.
`RUNTIME_SUPPORT_SUPPORTED`	A constant which can be used with the runtime_support property of a DatabaseToolsConnectionSummary.
`RUNTIME_SUPPORT_UNSUPPORTED`	A constant which can be used with the runtime_support property of a DatabaseToolsConnectionSummary.
`TYPE_GENERIC_JDBC`	A constant which can be used with the type property of a DatabaseToolsConnectionSummary.
`TYPE_MYSQL`	A constant which can be used with the type property of a DatabaseToolsConnectionSummary.
`TYPE_ORACLE_DATABASE`	A constant which can be used with the type property of a DatabaseToolsConnectionSummary.
`TYPE_POSTGRESQL`	A constant which can be used with the type property of a DatabaseToolsConnectionSummary.
`advanced_properties`	Gets the advanced_properties of this DatabaseToolsConnectionPostgresqlSummary.
`compartment_id`	[Required] Gets the compartment_id of this DatabaseToolsConnectionSummary.
`connection_string`	[Required] Gets the connection_string of this DatabaseToolsConnectionPostgresqlSummary.
`defined_tags`	Gets the defined_tags of this DatabaseToolsConnectionSummary.
`display_name`	[Required] Gets the display_name of this DatabaseToolsConnectionSummary.
`freeform_tags`	Gets the freeform_tags of this DatabaseToolsConnectionSummary.
`id`	[Required] Gets the id of this DatabaseToolsConnectionSummary.
`key_stores`	Gets the key_stores of this DatabaseToolsConnectionPostgresqlSummary.
`lifecycle_details`	Gets the lifecycle_details of this DatabaseToolsConnectionSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DatabaseToolsConnectionSummary.
`locks`	Gets the locks of this DatabaseToolsConnectionSummary.
`private_endpoint_id`	Gets the private_endpoint_id of this DatabaseToolsConnectionPostgresqlSummary.
`related_resource`	Gets the related_resource of this DatabaseToolsConnectionPostgresqlSummary.
`runtime_endpoint`	[Required] Gets the runtime_endpoint of this DatabaseToolsConnectionSummary.
`runtime_identity`	[Required] Gets the runtime_identity of this DatabaseToolsConnectionSummary.
`runtime_support`	[Required] Gets the runtime_support of this DatabaseToolsConnectionSummary.
`system_tags`	Gets the system_tags of this DatabaseToolsConnectionSummary.
`time_created`	[Required] Gets the time_created of this DatabaseToolsConnectionSummary.
`time_updated`	[Required] Gets the time_updated of this DatabaseToolsConnectionSummary.
`type`	[Required] Gets the type of this DatabaseToolsConnectionSummary.
`user_name`	Gets the user_name of this DatabaseToolsConnectionPostgresqlSummary.
`user_password`	Gets the user_password of this DatabaseToolsConnectionPostgresqlSummary.

Methods:

`__init__`(**kwargs)	Initializes a new DatabaseToolsConnectionPostgresqlSummary object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsConnectionSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsConnectionSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsConnectionSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsConnectionSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsConnectionSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsConnectionSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsConnectionSummary. This constant has a value of “UPDATING”

RUNTIME_IDENTITY_AUTHENTICATED_PRINCIPAL = 'AUTHENTICATED_PRINCIPAL'¶: A constant which can be used with the runtime_identity property of a DatabaseToolsConnectionSummary. This constant has a value of “AUTHENTICATED_PRINCIPAL”

RUNTIME_IDENTITY_RESOURCE_PRINCIPAL = 'RESOURCE_PRINCIPAL'¶: A constant which can be used with the runtime_identity property of a DatabaseToolsConnectionSummary. This constant has a value of “RESOURCE_PRINCIPAL”

RUNTIME_SUPPORT_SUPPORTED = 'SUPPORTED'¶: A constant which can be used with the runtime_support property of a DatabaseToolsConnectionSummary. This constant has a value of “SUPPORTED”

RUNTIME_SUPPORT_UNSUPPORTED = 'UNSUPPORTED'¶: A constant which can be used with the runtime_support property of a DatabaseToolsConnectionSummary. This constant has a value of “UNSUPPORTED”

TYPE_GENERIC_JDBC = 'GENERIC_JDBC'¶: A constant which can be used with the type property of a DatabaseToolsConnectionSummary. This constant has a value of “GENERIC_JDBC”

TYPE_MYSQL = 'MYSQL'¶: A constant which can be used with the type property of a DatabaseToolsConnectionSummary. This constant has a value of “MYSQL”

TYPE_ORACLE_DATABASE = 'ORACLE_DATABASE'¶: A constant which can be used with the type property of a DatabaseToolsConnectionSummary. This constant has a value of “ORACLE_DATABASE”

TYPE_POSTGRESQL = 'POSTGRESQL'¶: A constant which can be used with the type property of a DatabaseToolsConnectionSummary. This constant has a value of “POSTGRESQL”

__init__(**kwargs)¶

Initializes a new DatabaseToolsConnectionPostgresqlSummary object with values from keyword arguments. The default value of the type attribute of this class is POSTGRESQL and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

id (str) – The value to assign to the id property of this DatabaseToolsConnectionPostgresqlSummary.
display_name (str) – The value to assign to the display_name property of this DatabaseToolsConnectionPostgresqlSummary.
compartment_id (str) – The value to assign to the compartment_id property of this DatabaseToolsConnectionPostgresqlSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseToolsConnectionPostgresqlSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DatabaseToolsConnectionPostgresqlSummary.
time_created (datetime) – The value to assign to the time_created property of this DatabaseToolsConnectionPostgresqlSummary.
time_updated (datetime) – The value to assign to the time_updated property of this DatabaseToolsConnectionPostgresqlSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabaseToolsConnectionPostgresqlSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabaseToolsConnectionPostgresqlSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatabaseToolsConnectionPostgresqlSummary.
locks (list[oci.database_tools.models.ResourceLock]) – The value to assign to the locks property of this DatabaseToolsConnectionPostgresqlSummary.
type (str) – The value to assign to the type property of this DatabaseToolsConnectionPostgresqlSummary. Allowed values for this property are: “ORACLE_DATABASE”, “MYSQL”, “POSTGRESQL”, “GENERIC_JDBC”
runtime_support (str) – The value to assign to the runtime_support property of this DatabaseToolsConnectionPostgresqlSummary. Allowed values for this property are: “SUPPORTED”, “UNSUPPORTED”
runtime_endpoint (str) – The value to assign to the runtime_endpoint property of this DatabaseToolsConnectionPostgresqlSummary.
runtime_identity (str) – The value to assign to the runtime_identity property of this DatabaseToolsConnectionPostgresqlSummary. Allowed values for this property are: “AUTHENTICATED_PRINCIPAL”, “RESOURCE_PRINCIPAL”
related_resource (oci.database_tools.models.DatabaseToolsRelatedResourcePostgresql) – The value to assign to the related_resource property of this DatabaseToolsConnectionPostgresqlSummary.
connection_string (str) – The value to assign to the connection_string property of this DatabaseToolsConnectionPostgresqlSummary.
user_name (str) – The value to assign to the user_name property of this DatabaseToolsConnectionPostgresqlSummary.
user_password (oci.database_tools.models.DatabaseToolsUserPasswordSummary) – The value to assign to the user_password property of this DatabaseToolsConnectionPostgresqlSummary.
advanced_properties (dict(str, str)) – The value to assign to the advanced_properties property of this DatabaseToolsConnectionPostgresqlSummary.
key_stores (list[oci.database_tools.models.DatabaseToolsKeyStorePostgresqlSummary]) – The value to assign to the key_stores property of this DatabaseToolsConnectionPostgresqlSummary.
private_endpoint_id (str) – The value to assign to the private_endpoint_id property of this DatabaseToolsConnectionPostgresqlSummary.

property advanced_properties¶

Gets the advanced_properties of this DatabaseToolsConnectionPostgresqlSummary. The advanced connection properties key-value pair (e.g., sslMode).

Returns: The advanced_properties of this DatabaseToolsConnectionPostgresqlSummary.
Return type: dict(str, str)

property compartment_id¶

[Required] Gets the compartment_id of this DatabaseToolsConnectionSummary. The OCID of the compartment containing the Database Tools connection.

Returns: The compartment_id of this DatabaseToolsConnectionSummary.
Return type: str

property connection_string¶

[Required] Gets the connection_string of this DatabaseToolsConnectionPostgresqlSummary. The connection string used to connect to the PostgreSQL Server.

Returns: The connection_string of this DatabaseToolsConnectionPostgresqlSummary.
Return type: str

property defined_tags¶

Gets the defined_tags of this DatabaseToolsConnectionSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns: The defined_tags of this DatabaseToolsConnectionSummary.
Return type: dict(str, dict(str, object))

property display_name¶

[Required] Gets the display_name of this DatabaseToolsConnectionSummary. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

property freeform_tags¶

Gets the freeform_tags of this DatabaseToolsConnectionSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns: The freeform_tags of this DatabaseToolsConnectionSummary.
Return type: dict(str, str)

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property id¶

[Required] Gets the id of this DatabaseToolsConnectionSummary. The OCID of the Database Tools connection.

Returns: The id of this DatabaseToolsConnectionSummary.
Return type: str

property key_stores¶

Gets the key_stores of this DatabaseToolsConnectionPostgresqlSummary. The CA certificate to verify the server’s certificate and the client private key and associated certificate required for client authentication.

Returns: The key_stores of this DatabaseToolsConnectionPostgresqlSummary.
Return type: list[oci.database_tools.models.DatabaseToolsKeyStorePostgresqlSummary]

property lifecycle_details¶

Gets the lifecycle_details of this DatabaseToolsConnectionSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns: The lifecycle_details of this DatabaseToolsConnectionSummary.
Return type: str

property lifecycle_state¶

[Required] Gets the lifecycle_state of this DatabaseToolsConnectionSummary. The current state of the Database Tools connection.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The lifecycle_state of this DatabaseToolsConnectionSummary.
Return type: str

property locks¶

Gets the locks of this DatabaseToolsConnectionSummary. Locks associated with this resource.

Returns: The locks of this DatabaseToolsConnectionSummary.
Return type: list[oci.database_tools.models.ResourceLock]

property private_endpoint_id¶

Gets the private_endpoint_id of this DatabaseToolsConnectionPostgresqlSummary. The OCID of the Database Tools private endpoint used to access the database in the customer VCN.

Returns: The private_endpoint_id of this DatabaseToolsConnectionPostgresqlSummary.
Return type: str

property related_resource¶

Gets the related_resource of this DatabaseToolsConnectionPostgresqlSummary.

Returns: The related_resource of this DatabaseToolsConnectionPostgresqlSummary.
Return type: oci.database_tools.models.DatabaseToolsRelatedResourcePostgresql

property runtime_endpoint¶

[Required] Gets the runtime_endpoint of this DatabaseToolsConnectionSummary. Specifies the Database Tools Runtime endpoint.

Returns: The runtime_endpoint of this DatabaseToolsConnectionSummary.
Return type: str

property runtime_identity¶

[Required] Gets the runtime_identity of this DatabaseToolsConnectionSummary. Specifies the identity used when accessing OCI resources at runtime. AUTHENTICATED_PRINCIPAL to use the caller’s identity (On-Behalf-Of token), or RESOURCE_PRINCIPAL to use the connection’s resource principal (RPST).

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

Returns: The runtime_identity of this DatabaseToolsConnectionSummary.
Return type: str

property runtime_support¶

[Required] Gets the runtime_support of this DatabaseToolsConnectionSummary. Specifies whether this connection is supported by the Database Tools Runtime.

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

Returns: The runtime_support of this DatabaseToolsConnectionSummary.
Return type: str

property system_tags¶

Gets the system_tags of this DatabaseToolsConnectionSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns: The system_tags of this DatabaseToolsConnectionSummary.
Return type: dict(str, dict(str, object))

property time_created¶

[Required] Gets the time_created of this DatabaseToolsConnectionSummary. The time the Database Tools connection was created. An RFC3339 formatted datetime string.

Returns: The time_created of this DatabaseToolsConnectionSummary.
Return type: datetime

property time_updated¶

[Required] Gets the time_updated of this DatabaseToolsConnectionSummary. The time the Database Tools connection was updated. An RFC3339 formatted datetime string.

Returns: The time_updated of this DatabaseToolsConnectionSummary.
Return type: datetime

property type¶

[Required] Gets the type of this DatabaseToolsConnectionSummary. The Database Tools connection type.

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

Returns: The type of this DatabaseToolsConnectionSummary.
Return type: str

property user_name¶

Gets the user_name of this DatabaseToolsConnectionPostgresqlSummary. The database user name.

Returns: The user_name of this DatabaseToolsConnectionPostgresqlSummary.
Return type: str

property user_password¶

Gets the user_password of this DatabaseToolsConnectionPostgresqlSummary.

Returns: The user_password of this DatabaseToolsConnectionPostgresqlSummary.
Return type: oci.database_tools.models.DatabaseToolsUserPasswordSummary