DatabaseSummary¶

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

Bases: object

An Oracle Database on a bare metal or virtual machine DB system. For more information, see Bare Metal and Virtual Machine DB Systems.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes:

`DATA_SAFE_STATE_DISABLED`	A constant which can be used with the data_safe_state property of a DatabaseSummary.
`DATA_SAFE_STATE_ENABLED`	A constant which can be used with the data_safe_state property of a DatabaseSummary.
`DATA_SAFE_STATE_FAILED`	A constant which can be used with the data_safe_state property of a DatabaseSummary.
`HOME_TYPE_CUSTOMER_MANAGED`	A constant which can be used with the home_type property of a DatabaseSummary.
`HOME_TYPE_ORACLE_MANAGED`	A constant which can be used with the home_type property of a DatabaseSummary.
`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a DatabaseSummary.
`LIFECYCLE_STATE_BACKUP_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a DatabaseSummary.
`LIFECYCLE_STATE_CONVERTING`	A constant which can be used with the lifecycle_state property of a DatabaseSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DatabaseSummary.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a DatabaseSummary.
`LIFECYCLE_STATE_RESTORE_FAILED`	A constant which can be used with the lifecycle_state property of a DatabaseSummary.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a DatabaseSummary.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a DatabaseSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DatabaseSummary.
`LIFECYCLE_STATE_UPGRADING`	A constant which can be used with the lifecycle_state property of a DatabaseSummary.
`character_set`	Gets the character_set of this DatabaseSummary.
`compartment_id`	[Required] Gets the compartment_id of this DatabaseSummary.
`connection_strings`	Gets the connection_strings of this DatabaseSummary.
`data_guard_group`	Gets the data_guard_group of this DatabaseSummary.
`data_safe_registration_details`	Gets the data_safe_registration_details of this DatabaseSummary.
`data_safe_state`	Gets the data_safe_state of this DatabaseSummary.
`database_management_config`	Gets the database_management_config of this DatabaseSummary.
`database_software_image_id`	Gets the database_software_image_id of this DatabaseSummary.
`db_backup_config`	Gets the db_backup_config of this DatabaseSummary.
`db_home_id`	Gets the db_home_id of this DatabaseSummary.
`db_name`	[Required] Gets the db_name of this DatabaseSummary.
`db_system_id`	Gets the db_system_id of this DatabaseSummary.
`db_unique_name`	[Required] Gets the db_unique_name of this DatabaseSummary.
`db_workload`	Gets the db_workload of this DatabaseSummary.
`defined_tags`	Gets the defined_tags of this DatabaseSummary.
`encryption_key_location_details`	Gets the encryption_key_location_details of this DatabaseSummary.
`freeform_tags`	Gets the freeform_tags of this DatabaseSummary.
`home_type`	Gets the home_type of this DatabaseSummary.
`id`	[Required] Gets the id of this DatabaseSummary.
`is_cdb`	Gets the is_cdb of this DatabaseSummary.
`key_store_id`	Gets the key_store_id of this DatabaseSummary.
`key_store_wallet_name`	Gets the key_store_wallet_name of this DatabaseSummary.
`kms_key_id`	Gets the kms_key_id of this DatabaseSummary.
`kms_key_version_id`	Gets the kms_key_version_id of this DatabaseSummary.
`last_backup_duration_in_seconds`	Gets the last_backup_duration_in_seconds of this DatabaseSummary.
`last_backup_timestamp`	Gets the last_backup_timestamp of this DatabaseSummary.
`last_failed_backup_timestamp`	Gets the last_failed_backup_timestamp of this DatabaseSummary.
`lifecycle_details`	Gets the lifecycle_details of this DatabaseSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DatabaseSummary.
`managed_software_update_details`	Gets the managed_software_update_details of this DatabaseSummary.
`ncharacter_set`	Gets the ncharacter_set of this DatabaseSummary.
`patch_version`	Gets the patch_version of this DatabaseSummary.
`pdb_name`	Gets the pdb_name of this DatabaseSummary.
`sid_prefix`	Gets the sid_prefix of this DatabaseSummary.
`source_database_point_in_time_recovery_timestamp`	Gets the source_database_point_in_time_recovery_timestamp of this DatabaseSummary.
`storage_size_details`	Gets the storage_size_details of this DatabaseSummary.
`system_tags`	Gets the system_tags of this DatabaseSummary.
`time_created`	Gets the time_created of this DatabaseSummary.
`vault_id`	Gets the vault_id of this DatabaseSummary.
`vm_cluster_id`	Gets the vm_cluster_id of this DatabaseSummary.

Methods:

__init__(**kwargs)

Initializes a new DatabaseSummary object with values from keyword arguments.

DATA_SAFE_STATE_DISABLED = 'DISABLED'¶: A constant which can be used with the data_safe_state property of a DatabaseSummary. This constant has a value of “DISABLED”

DATA_SAFE_STATE_ENABLED = 'ENABLED'¶: A constant which can be used with the data_safe_state property of a DatabaseSummary. This constant has a value of “ENABLED”

DATA_SAFE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the data_safe_state property of a DatabaseSummary. This constant has a value of “FAILED”

HOME_TYPE_CUSTOMER_MANAGED = 'CUSTOMER_MANAGED'¶: A constant which can be used with the home_type property of a DatabaseSummary. This constant has a value of “CUSTOMER_MANAGED”

HOME_TYPE_ORACLE_MANAGED = 'ORACLE_MANAGED'¶: A constant which can be used with the home_type property of a DatabaseSummary. This constant has a value of “ORACLE_MANAGED”

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a DatabaseSummary. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_BACKUP_IN_PROGRESS = 'BACKUP_IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a DatabaseSummary. This constant has a value of “BACKUP_IN_PROGRESS”

LIFECYCLE_STATE_CONVERTING = 'CONVERTING'¶: A constant which can be used with the lifecycle_state property of a DatabaseSummary. This constant has a value of “CONVERTING”

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

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a DatabaseSummary. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_RESTORE_FAILED = 'RESTORE_FAILED'¶: A constant which can be used with the lifecycle_state property of a DatabaseSummary. This constant has a value of “RESTORE_FAILED”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a DatabaseSummary. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a DatabaseSummary. This constant has a value of “TERMINATING”

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

LIFECYCLE_STATE_UPGRADING = 'UPGRADING'¶: A constant which can be used with the lifecycle_state property of a DatabaseSummary. This constant has a value of “UPGRADING”

__init__(**kwargs)¶

Initializes a new DatabaseSummary 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 DatabaseSummary.
compartment_id (str) – The value to assign to the compartment_id property of this DatabaseSummary.
character_set (str) – The value to assign to the character_set property of this DatabaseSummary.
ncharacter_set (str) – The value to assign to the ncharacter_set property of this DatabaseSummary.
db_home_id (str) – The value to assign to the db_home_id property of this DatabaseSummary.
db_system_id (str) – The value to assign to the db_system_id property of this DatabaseSummary.
vm_cluster_id (str) – The value to assign to the vm_cluster_id property of this DatabaseSummary.
db_name (str) – The value to assign to the db_name property of this DatabaseSummary.
pdb_name (str) – The value to assign to the pdb_name property of this DatabaseSummary.
db_workload (str) – The value to assign to the db_workload property of this DatabaseSummary.
db_unique_name (str) – The value to assign to the db_unique_name property of this DatabaseSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DatabaseSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseSummary. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “BACKUP_IN_PROGRESS”, “UPGRADING”, “CONVERTING”, “TERMINATING”, “TERMINATED”, “RESTORE_FAILED”, “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 DatabaseSummary.
last_backup_timestamp (datetime) – The value to assign to the last_backup_timestamp property of this DatabaseSummary.
last_backup_duration_in_seconds (int) – The value to assign to the last_backup_duration_in_seconds property of this DatabaseSummary.
last_failed_backup_timestamp (datetime) – The value to assign to the last_failed_backup_timestamp property of this DatabaseSummary.
db_backup_config (oci.database.models.DbBackupConfig) – The value to assign to the db_backup_config property of this DatabaseSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabaseSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabaseSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatabaseSummary.
connection_strings (oci.database.models.DatabaseConnectionStrings) – The value to assign to the connection_strings property of this DatabaseSummary.
kms_key_id (str) – The value to assign to the kms_key_id property of this DatabaseSummary.
kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this DatabaseSummary.
vault_id (str) – The value to assign to the vault_id property of this DatabaseSummary.
source_database_point_in_time_recovery_timestamp (datetime) – The value to assign to the source_database_point_in_time_recovery_timestamp property of this DatabaseSummary.
database_software_image_id (str) – The value to assign to the database_software_image_id property of this DatabaseSummary.
is_cdb (bool) – The value to assign to the is_cdb property of this DatabaseSummary.
database_management_config (oci.database.models.CloudDatabaseManagementConfig) – The value to assign to the database_management_config property of this DatabaseSummary.
sid_prefix (str) – The value to assign to the sid_prefix property of this DatabaseSummary.
key_store_id (str) – The value to assign to the key_store_id property of this DatabaseSummary.
key_store_wallet_name (str) – The value to assign to the key_store_wallet_name property of this DatabaseSummary.
data_guard_group (oci.database.models.DataGuardGroup) – The value to assign to the data_guard_group property of this DatabaseSummary.
encryption_key_location_details (oci.database.models.EncryptionKeyLocationDetails) – The value to assign to the encryption_key_location_details property of this DatabaseSummary.
storage_size_details (oci.database.models.DatabaseStorageSizeResponseDetails) – The value to assign to the storage_size_details property of this DatabaseSummary.
managed_software_update_details (oci.database.models.ManagedSoftwareUpdateDetails) – The value to assign to the managed_software_update_details property of this DatabaseSummary.
home_type (str) – The value to assign to the home_type property of this DatabaseSummary. Allowed values for this property are: “ORACLE_MANAGED”, “CUSTOMER_MANAGED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
patch_version (str) – The value to assign to the patch_version property of this DatabaseSummary.
data_safe_state (str) – The value to assign to the data_safe_state property of this DatabaseSummary. Allowed values for this property are: “ENABLED”, “DISABLED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
data_safe_registration_details (oci.database.models.DataSafeRegistrationDetails) – The value to assign to the data_safe_registration_details property of this DatabaseSummary.

property character_set¶

Gets the character_set of this DatabaseSummary. The character set for the database.

Returns: The character_set of this DatabaseSummary.
Return type: str

property compartment_id¶

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

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

property connection_strings¶

Gets the connection_strings of this DatabaseSummary. The Connection strings used to connect to the Oracle Database.

Returns: The connection_strings of this DatabaseSummary.
Return type: oci.database.models.DatabaseConnectionStrings

property data_guard_group¶

Gets the data_guard_group of this DatabaseSummary.

Returns: The data_guard_group of this DatabaseSummary.
Return type: oci.database.models.DataGuardGroup

property data_safe_registration_details¶

Gets the data_safe_registration_details of this DatabaseSummary.

Returns: The data_safe_registration_details of this DatabaseSummary.
Return type: oci.database.models.DataSafeRegistrationDetails

property data_safe_state¶

Gets the data_safe_state of this DatabaseSummary. The Data Safe status of the database.

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

Returns: The data_safe_state of this DatabaseSummary.
Return type: str

property database_management_config¶

Gets the database_management_config of this DatabaseSummary.

Returns: The database_management_config of this DatabaseSummary.
Return type: oci.database.models.CloudDatabaseManagementConfig

property database_software_image_id¶

Gets the database_software_image_id of this DatabaseSummary. The database software image OCID

Returns: The database_software_image_id of this DatabaseSummary.
Return type: str

property db_backup_config¶

Gets the db_backup_config of this DatabaseSummary.

Returns: The db_backup_config of this DatabaseSummary.
Return type: oci.database.models.DbBackupConfig

property db_home_id¶

Gets the db_home_id of this DatabaseSummary. The OCID of the Database Home.

Returns: The db_home_id of this DatabaseSummary.
Return type: str

property db_name¶

[Required] Gets the db_name of this DatabaseSummary. The database name.

Returns: The db_name of this DatabaseSummary.
Return type: str

property db_system_id¶

Gets the db_system_id of this DatabaseSummary. The OCID of the DB system.

Returns: The db_system_id of this DatabaseSummary.
Return type: str

property db_unique_name¶

[Required] Gets the db_unique_name of this DatabaseSummary. A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

Returns: The db_unique_name of this DatabaseSummary.
Return type: str

property db_workload¶

Gets the db_workload of this DatabaseSummary. Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.

The database workload type.

Returns: The db_workload of this DatabaseSummary.
Return type: str

property defined_tags¶

Gets the defined_tags of this DatabaseSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

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

property encryption_key_location_details¶

Gets the encryption_key_location_details of this DatabaseSummary.

Returns: The encryption_key_location_details of this DatabaseSummary.
Return type: oci.database.models.EncryptionKeyLocationDetails

property freeform_tags¶

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

property home_type¶

Gets the home_type of this DatabaseSummary. Represents database will be under oracle managed home or customer managed home

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

Returns: The home_type of this DatabaseSummary.
Return type: str

property id¶

[Required] Gets the id of this DatabaseSummary. The OCID of the database.

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

property is_cdb¶

Gets the is_cdb of this DatabaseSummary. True if the database is a container database.

Returns: The is_cdb of this DatabaseSummary.
Return type: bool

property key_store_id¶

Gets the key_store_id of this DatabaseSummary. The OCID of the key store of Oracle Vault.

Returns: The key_store_id of this DatabaseSummary.
Return type: str

property key_store_wallet_name¶

Gets the key_store_wallet_name of this DatabaseSummary. The wallet name for Oracle Key Vault.

Returns: The key_store_wallet_name of this DatabaseSummary.
Return type: str

property kms_key_id¶

Gets the kms_key_id of this DatabaseSummary. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Returns: The kms_key_id of this DatabaseSummary.
Return type: str

property kms_key_version_id¶

Gets the kms_key_version_id of this DatabaseSummary. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances.

Returns: The kms_key_version_id of this DatabaseSummary.
Return type: str

property last_backup_duration_in_seconds¶

Gets the last_backup_duration_in_seconds of this DatabaseSummary. The duration when the latest database backup created.

Returns: The last_backup_duration_in_seconds of this DatabaseSummary.
Return type: int

property last_backup_timestamp¶

Gets the last_backup_timestamp of this DatabaseSummary. The date and time when the latest database backup was created.

Returns: The last_backup_timestamp of this DatabaseSummary.
Return type: datetime

property last_failed_backup_timestamp¶

Gets the last_failed_backup_timestamp of this DatabaseSummary. The date and time when the latest database backup failed.

Returns: The last_failed_backup_timestamp of this DatabaseSummary.
Return type: datetime

property lifecycle_details¶

Gets the lifecycle_details of this DatabaseSummary. Additional information about the current lifecycle state.

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

property lifecycle_state¶

[Required] Gets the lifecycle_state of this DatabaseSummary. The current state of the database.

Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “BACKUP_IN_PROGRESS”, “UPGRADING”, “CONVERTING”, “TERMINATING”, “TERMINATED”, “RESTORE_FAILED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

property managed_software_update_details¶

Gets the managed_software_update_details of this DatabaseSummary.

Returns: The managed_software_update_details of this DatabaseSummary.
Return type: oci.database.models.ManagedSoftwareUpdateDetails

property ncharacter_set¶

Gets the ncharacter_set of this DatabaseSummary. The national character set for the database.

Returns: The ncharacter_set of this DatabaseSummary.
Return type: str

property patch_version¶

Gets the patch_version of this DatabaseSummary. The patch version of the database.

Returns: The patch_version of this DatabaseSummary.
Return type: str

property pdb_name¶

Gets the pdb_name of this DatabaseSummary. The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

Returns: The pdb_name of this DatabaseSummary.
Return type: str

property sid_prefix¶

Gets the sid_prefix of this DatabaseSummary. Specifies a prefix for the Oracle SID of the database to be created.

Returns: The sid_prefix of this DatabaseSummary.
Return type: str

property source_database_point_in_time_recovery_timestamp¶

Gets the source_database_point_in_time_recovery_timestamp of this DatabaseSummary. Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

Returns: The source_database_point_in_time_recovery_timestamp of this DatabaseSummary.
Return type: datetime

property storage_size_details¶

Gets the storage_size_details of this DatabaseSummary.

Returns: The storage_size_details of this DatabaseSummary.
Return type: oci.database.models.DatabaseStorageSizeResponseDetails

property system_tags¶

Gets the system_tags of this DatabaseSummary. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

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

property time_created¶

Gets the time_created of this DatabaseSummary. The date and time the database was created.

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

property vault_id¶

Gets the vault_id of this DatabaseSummary. The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

Returns: The vault_id of this DatabaseSummary.
Return type: str

property vm_cluster_id¶

Gets the vm_cluster_id of this DatabaseSummary. The OCID of the VM cluster.

Returns: The vm_cluster_id of this DatabaseSummary.
Return type: str