ExternalDatabaseSummary

class oci.database_management.models.ExternalDatabaseSummary(**kwargs)

Bases: object

The summary of an external database.

Attributes

DATABASE_SUB_TYPE_ACD A constant which can be used with the database_sub_type property of a ExternalDatabaseSummary.
DATABASE_SUB_TYPE_ADB A constant which can be used with the database_sub_type property of a ExternalDatabaseSummary.
DATABASE_SUB_TYPE_CDB A constant which can be used with the database_sub_type property of a ExternalDatabaseSummary.
DATABASE_SUB_TYPE_NON_CDB A constant which can be used with the database_sub_type property of a ExternalDatabaseSummary.
DATABASE_SUB_TYPE_PDB A constant which can be used with the database_sub_type property of a ExternalDatabaseSummary.
DATABASE_TYPE_CLOUD_RAC A constant which can be used with the database_type property of a ExternalDatabaseSummary.
DATABASE_TYPE_CLOUD_SIDB A constant which can be used with the database_type property of a ExternalDatabaseSummary.
DATABASE_TYPE_DEDICATED A constant which can be used with the database_type property of a ExternalDatabaseSummary.
DATABASE_TYPE_EXTERNAL_RAC A constant which can be used with the database_type property of a ExternalDatabaseSummary.
DATABASE_TYPE_EXTERNAL_SIDB A constant which can be used with the database_type property of a ExternalDatabaseSummary.
DATABASE_TYPE_SHARED A constant which can be used with the database_type property of a ExternalDatabaseSummary.
LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a ExternalDatabaseSummary.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a ExternalDatabaseSummary.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a ExternalDatabaseSummary.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a ExternalDatabaseSummary.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a ExternalDatabaseSummary.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a ExternalDatabaseSummary.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a ExternalDatabaseSummary.
compartment_id [Required] Gets the compartment_id of this ExternalDatabaseSummary.
database_platform_name Gets the database_platform_name of this ExternalDatabaseSummary.
database_sub_type Gets the database_sub_type of this ExternalDatabaseSummary.
database_type Gets the database_type of this ExternalDatabaseSummary.
database_version Gets the database_version of this ExternalDatabaseSummary.
db_management_config Gets the db_management_config of this ExternalDatabaseSummary.
db_system_info Gets the db_system_info of this ExternalDatabaseSummary.
db_unique_name Gets the db_unique_name of this ExternalDatabaseSummary.
dbmgmt_feature_configs Gets the dbmgmt_feature_configs of this ExternalDatabaseSummary.
defined_tags Gets the defined_tags of this ExternalDatabaseSummary.
display_name [Required] Gets the display_name of this ExternalDatabaseSummary.
external_container_database_id Gets the external_container_database_id of this ExternalDatabaseSummary.
external_db_home_id Gets the external_db_home_id of this ExternalDatabaseSummary.
freeform_tags Gets the freeform_tags of this ExternalDatabaseSummary.
id [Required] Gets the id of this ExternalDatabaseSummary.
instance_details Gets the instance_details of this ExternalDatabaseSummary.
lifecycle_state [Required] Gets the lifecycle_state of this ExternalDatabaseSummary.
system_tags Gets the system_tags of this ExternalDatabaseSummary.
time_created [Required] Gets the time_created of this ExternalDatabaseSummary.

Methods

__init__(**kwargs) Initializes a new ExternalDatabaseSummary object with values from keyword arguments.
DATABASE_SUB_TYPE_ACD = 'ACD'

A constant which can be used with the database_sub_type property of a ExternalDatabaseSummary. This constant has a value of “ACD”

DATABASE_SUB_TYPE_ADB = 'ADB'

A constant which can be used with the database_sub_type property of a ExternalDatabaseSummary. This constant has a value of “ADB”

DATABASE_SUB_TYPE_CDB = 'CDB'

A constant which can be used with the database_sub_type property of a ExternalDatabaseSummary. This constant has a value of “CDB”

DATABASE_SUB_TYPE_NON_CDB = 'NON_CDB'

A constant which can be used with the database_sub_type property of a ExternalDatabaseSummary. This constant has a value of “NON_CDB”

DATABASE_SUB_TYPE_PDB = 'PDB'

A constant which can be used with the database_sub_type property of a ExternalDatabaseSummary. This constant has a value of “PDB”

DATABASE_TYPE_CLOUD_RAC = 'CLOUD_RAC'

A constant which can be used with the database_type property of a ExternalDatabaseSummary. This constant has a value of “CLOUD_RAC”

DATABASE_TYPE_CLOUD_SIDB = 'CLOUD_SIDB'

A constant which can be used with the database_type property of a ExternalDatabaseSummary. This constant has a value of “CLOUD_SIDB”

DATABASE_TYPE_DEDICATED = 'DEDICATED'

A constant which can be used with the database_type property of a ExternalDatabaseSummary. This constant has a value of “DEDICATED”

DATABASE_TYPE_EXTERNAL_RAC = 'EXTERNAL_RAC'

A constant which can be used with the database_type property of a ExternalDatabaseSummary. This constant has a value of “EXTERNAL_RAC”

DATABASE_TYPE_EXTERNAL_SIDB = 'EXTERNAL_SIDB'

A constant which can be used with the database_type property of a ExternalDatabaseSummary. This constant has a value of “EXTERNAL_SIDB”

DATABASE_TYPE_SHARED = 'SHARED'

A constant which can be used with the database_type property of a ExternalDatabaseSummary. This constant has a value of “SHARED”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a ExternalDatabaseSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a ExternalDatabaseSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a ExternalDatabaseSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a ExternalDatabaseSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a ExternalDatabaseSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a ExternalDatabaseSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a ExternalDatabaseSummary. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new ExternalDatabaseSummary object with values from keyword arguments. 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 ExternalDatabaseSummary.
  • display_name (str) – The value to assign to the display_name property of this ExternalDatabaseSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this ExternalDatabaseSummary.
  • db_unique_name (str) – The value to assign to the db_unique_name property of this ExternalDatabaseSummary.
  • database_type (str) – The value to assign to the database_type property of this ExternalDatabaseSummary. Allowed values for this property are: “EXTERNAL_SIDB”, “EXTERNAL_RAC”, “CLOUD_SIDB”, “CLOUD_RAC”, “SHARED”, “DEDICATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • database_sub_type (str) – The value to assign to the database_sub_type property of this ExternalDatabaseSummary. Allowed values for this property are: “CDB”, “PDB”, “NON_CDB”, “ACD”, “ADB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • external_container_database_id (str) – The value to assign to the external_container_database_id property of this ExternalDatabaseSummary.
  • external_db_home_id (str) – The value to assign to the external_db_home_id property of this ExternalDatabaseSummary.
  • db_system_info (oci.database_management.models.ExternalDbSystemBasicInfo) – The value to assign to the db_system_info property of this ExternalDatabaseSummary.
  • db_management_config (oci.database_management.models.DatabaseManagementConfig) – The value to assign to the db_management_config property of this ExternalDatabaseSummary.
  • instance_details (list[oci.database_management.models.ExternalDatabaseInstance]) – The value to assign to the instance_details property of this ExternalDatabaseSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this ExternalDatabaseSummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • time_created (datetime) – The value to assign to the time_created property of this ExternalDatabaseSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ExternalDatabaseSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ExternalDatabaseSummary.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ExternalDatabaseSummary.
  • dbmgmt_feature_configs (list[oci.database_management.models.DatabaseFeatureConfiguration]) – The value to assign to the dbmgmt_feature_configs property of this ExternalDatabaseSummary.
  • database_version (str) – The value to assign to the database_version property of this ExternalDatabaseSummary.
  • database_platform_name (str) – The value to assign to the database_platform_name property of this ExternalDatabaseSummary.
compartment_id

[Required] Gets the compartment_id of this ExternalDatabaseSummary. The OCID of the compartment.

Returns:The compartment_id of this ExternalDatabaseSummary.
Return type:str
database_platform_name

Gets the database_platform_name of this ExternalDatabaseSummary. The operating system of database.

Returns:The database_platform_name of this ExternalDatabaseSummary.
Return type:str
database_sub_type

Gets the database_sub_type of this ExternalDatabaseSummary. The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or Non-container Database.

Allowed values for this property are: “CDB”, “PDB”, “NON_CDB”, “ACD”, “ADB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The database_sub_type of this ExternalDatabaseSummary.
Return type:str
database_type

Gets the database_type of this ExternalDatabaseSummary. The type of Oracle Database installation.

Allowed values for this property are: “EXTERNAL_SIDB”, “EXTERNAL_RAC”, “CLOUD_SIDB”, “CLOUD_RAC”, “SHARED”, “DEDICATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The database_type of this ExternalDatabaseSummary.
Return type:str
database_version

Gets the database_version of this ExternalDatabaseSummary. The Oracle database version.

Returns:The database_version of this ExternalDatabaseSummary.
Return type:str
db_management_config

Gets the db_management_config of this ExternalDatabaseSummary.

Returns:The db_management_config of this ExternalDatabaseSummary.
Return type:oci.database_management.models.DatabaseManagementConfig
db_system_info

Gets the db_system_info of this ExternalDatabaseSummary.

Returns:The db_system_info of this ExternalDatabaseSummary.
Return type:oci.database_management.models.ExternalDbSystemBasicInfo
db_unique_name

Gets the db_unique_name of this ExternalDatabaseSummary. The DB_UNIQUE_NAME of the external database.

Returns:The db_unique_name of this ExternalDatabaseSummary.
Return type:str
dbmgmt_feature_configs

Gets the dbmgmt_feature_configs of this ExternalDatabaseSummary. The list of feature configurations

Returns:The dbmgmt_feature_configs of this ExternalDatabaseSummary.
Return type:list[oci.database_management.models.DatabaseFeatureConfiguration]
defined_tags

Gets the defined_tags of this ExternalDatabaseSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

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

[Required] Gets the display_name of this ExternalDatabaseSummary. The user-friendly name for the database. The name does not have to be unique.

Returns:The display_name of this ExternalDatabaseSummary.
Return type:str
external_container_database_id

Gets the external_container_database_id of this ExternalDatabaseSummary. The OCID of the parent Container Database (CDB) if this is a Pluggable Database (PDB).

Returns:The external_container_database_id of this ExternalDatabaseSummary.
Return type:str
external_db_home_id

Gets the external_db_home_id of this ExternalDatabaseSummary. The OCID of the external DB home.

Returns:The external_db_home_id of this ExternalDatabaseSummary.
Return type:str
freeform_tags

Gets the freeform_tags of this ExternalDatabaseSummary. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

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

[Required] Gets the id of this ExternalDatabaseSummary. The OCID of the external DB system.

Returns:The id of this ExternalDatabaseSummary.
Return type:str
instance_details

Gets the instance_details of this ExternalDatabaseSummary. The list of database instances if the database is a RAC database.

Returns:The instance_details of this ExternalDatabaseSummary.
Return type:list[oci.database_management.models.ExternalDatabaseInstance]
lifecycle_state

[Required] Gets the lifecycle_state of this ExternalDatabaseSummary. The current lifecycle state of the external database resource.

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

Returns:The lifecycle_state of this ExternalDatabaseSummary.
Return type:str
system_tags

Gets the system_tags of this ExternalDatabaseSummary. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

[Required] Gets the time_created of this ExternalDatabaseSummary. The date and time the external DB system was created.

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