DbHomeSummary¶

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

Bases: object

A directory where Oracle Database software is installed. A bare metal or Exadata DB system can have multiple Database Homes and each Database Home can run a different supported version of Oracle Database. A virtual machine DB system can have only one Database Home. For more information, see Bare Metal and Virtual Machine DB Systems and Exadata 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:

`HOME_TYPE_CUSTOMER_MANAGED`	A constant which can be used with the home_type property of a DbHomeSummary.
`HOME_TYPE_ORACLE_MANAGED`	A constant which can be used with the home_type property of a DbHomeSummary.
`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a DbHomeSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DbHomeSummary.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a DbHomeSummary.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a DbHomeSummary.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a DbHomeSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DbHomeSummary.
`compartment_id`	[Required] Gets the compartment_id of this DbHomeSummary.
`database_software_image_id`	Gets the database_software_image_id of this DbHomeSummary.
`db_home_location`	[Required] Gets the db_home_location of this DbHomeSummary.
`db_system_id`	Gets the db_system_id of this DbHomeSummary.
`db_version`	[Required] Gets the db_version of this DbHomeSummary.
`defined_tags`	Gets the defined_tags of this DbHomeSummary.
`display_name`	[Required] Gets the display_name of this DbHomeSummary.
`freeform_tags`	Gets the freeform_tags of this DbHomeSummary.
`home_type`	Gets the home_type of this DbHomeSummary.
`id`	[Required] Gets the id of this DbHomeSummary.
`is_unified_auditing_enabled`	Gets the is_unified_auditing_enabled of this DbHomeSummary.
`kms_key_id`	Gets the kms_key_id of this DbHomeSummary.
`last_patch_history_entry_id`	Gets the last_patch_history_entry_id of this DbHomeSummary.
`lifecycle_details`	Gets the lifecycle_details of this DbHomeSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DbHomeSummary.
`one_off_patches`	Gets the one_off_patches of this DbHomeSummary.
`system_tags`	Gets the system_tags of this DbHomeSummary.
`time_created`	Gets the time_created of this DbHomeSummary.
`vm_cluster_id`	Gets the vm_cluster_id of this DbHomeSummary.

Methods:

__init__(**kwargs)

Initializes a new DbHomeSummary object with values from keyword arguments.

HOME_TYPE_CUSTOMER_MANAGED = 'CUSTOMER_MANAGED'¶: A constant which can be used with the home_type property of a DbHomeSummary. 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 DbHomeSummary. 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 DbHomeSummary. This constant has a value of “AVAILABLE”

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new DbHomeSummary 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 DbHomeSummary.
compartment_id (str) – The value to assign to the compartment_id property of this DbHomeSummary.
display_name (str) – The value to assign to the display_name property of this DbHomeSummary.
last_patch_history_entry_id (str) – The value to assign to the last_patch_history_entry_id property of this DbHomeSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DbHomeSummary. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
db_system_id (str) – The value to assign to the db_system_id property of this DbHomeSummary.
vm_cluster_id (str) – The value to assign to the vm_cluster_id property of this DbHomeSummary.
db_version (str) – The value to assign to the db_version property of this DbHomeSummary.
db_home_location (str) – The value to assign to the db_home_location property of this DbHomeSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DbHomeSummary.
time_created (datetime) – The value to assign to the time_created property of this DbHomeSummary.
kms_key_id (str) – The value to assign to the kms_key_id property of this DbHomeSummary.
one_off_patches (list[str]) – The value to assign to the one_off_patches property of this DbHomeSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DbHomeSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DbHomeSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DbHomeSummary.
database_software_image_id (str) – The value to assign to the database_software_image_id property of this DbHomeSummary.
is_unified_auditing_enabled (bool) – The value to assign to the is_unified_auditing_enabled property of this DbHomeSummary.
home_type (str) – The value to assign to the home_type property of this DbHomeSummary. 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’.

property compartment_id¶

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

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

property database_software_image_id¶

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

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

property db_home_location¶

[Required] Gets the db_home_location of this DbHomeSummary. The location of the Oracle Database Home.

Returns: The db_home_location of this DbHomeSummary.
Return type: str

property db_system_id¶

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

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

property db_version¶

[Required] Gets the db_version of this DbHomeSummary. The Oracle Database version.

Returns: The db_version of this DbHomeSummary.
Return type: str

property defined_tags¶

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

property display_name¶

[Required] Gets the display_name of this DbHomeSummary. The user-provided name for the Database Home. The name does not need to be unique.

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

property freeform_tags¶

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

property home_type¶

Gets the home_type of this DbHomeSummary. Represents database home will be managed by oracle or customer

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

property id¶

[Required] Gets the id of this DbHomeSummary. The OCID of the Database Home.

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

property is_unified_auditing_enabled¶

Gets the is_unified_auditing_enabled of this DbHomeSummary. Indicates whether unified autiding is enabled or not.

Returns: The is_unified_auditing_enabled of this DbHomeSummary.
Return type: bool

property kms_key_id¶

Gets the kms_key_id of this DbHomeSummary. 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 DbHomeSummary.
Return type: str

property last_patch_history_entry_id¶

Gets the last_patch_history_entry_id of this DbHomeSummary. The OCID of the last patch history. This value is updated as soon as a patch operation is started.

Returns: The last_patch_history_entry_id of this DbHomeSummary.
Return type: str

property lifecycle_details¶

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

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

property lifecycle_state¶

[Required] Gets the lifecycle_state of this DbHomeSummary. The current state of the Database Home.

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

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

property one_off_patches¶

Gets the one_off_patches of this DbHomeSummary. List of one-off patches for Database Homes.

Returns: The one_off_patches of this DbHomeSummary.
Return type: list[str]

property system_tags¶

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

property time_created¶

Gets the time_created of this DbHomeSummary. The date and time the Database Home was created.

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

property vm_cluster_id¶

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

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