DatabaseToolsConnection¶

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

Bases: object

Provides connectivity details required to establish a connection to a database.

Attributes

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

Methods

`__init__`(**kwargs)	Initializes a new DatabaseToolsConnection 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 DatabaseToolsConnection. This constant has a value of “ACTIVE”

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

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

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

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

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsConnection. 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 DatabaseToolsConnection. 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 DatabaseToolsConnection. 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 DatabaseToolsConnection. This constant has a value of “SUPPORTED”

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new DatabaseToolsConnection object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

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 DatabaseToolsConnection.
display_name (str) – The value to assign to the display_name property of this DatabaseToolsConnection.
compartment_id (str) – The value to assign to the compartment_id property of this DatabaseToolsConnection.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseToolsConnection. 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’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DatabaseToolsConnection.
time_created (datetime) – The value to assign to the time_created property of this DatabaseToolsConnection.
time_updated (datetime) – The value to assign to the time_updated property of this DatabaseToolsConnection.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabaseToolsConnection.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabaseToolsConnection.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatabaseToolsConnection.
locks (list[oci.database_tools.models.ResourceLock]) – The value to assign to the locks property of this DatabaseToolsConnection.
type (str) – The value to assign to the type property of this DatabaseToolsConnection. 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’.
runtime_support (str) – The value to assign to the runtime_support property of this DatabaseToolsConnection. 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’.
runtime_endpoint (str) – The value to assign to the runtime_endpoint property of this DatabaseToolsConnection.
runtime_identity (str) – The value to assign to the runtime_identity property of this DatabaseToolsConnection. 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’.

compartment_id¶

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

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

defined_tags¶

Gets the defined_tags of this DatabaseToolsConnection. 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 DatabaseToolsConnection.
Return type:	dict(str, dict(str, object))

display_name¶

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

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

freeform_tags¶

Gets the freeform_tags of this DatabaseToolsConnection. 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 DatabaseToolsConnection.
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.

id¶

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

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

lifecycle_details¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this DatabaseToolsConnection. 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 DatabaseToolsConnection.
Return type:	str

locks¶

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

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

runtime_endpoint¶

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

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

runtime_identity¶

[Required] Gets the runtime_identity of this DatabaseToolsConnection. Specifies the identity used by the Database Tools service to issue requests to other OCI services (e.g., Secrets in Vault).

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 DatabaseToolsConnection.
Return type:	str

runtime_support¶

[Required] Gets the runtime_support of this DatabaseToolsConnection. 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 DatabaseToolsConnection.
Return type:	str

system_tags¶

Gets the system_tags of this DatabaseToolsConnection. 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 DatabaseToolsConnection.
Return type:	dict(str, dict(str, object))

time_created¶

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

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

time_updated¶

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

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

type¶

[Required] Gets the type of this DatabaseToolsConnection. 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 DatabaseToolsConnection.
Return type:	str