DbHome¶

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

Bases: object

DbHome model.

Attributes

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

Methods

__init__(**kwargs) Initializes a new DbHome object with values from keyword arguments.

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new DbHome 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 DbHome.
compartment_id (str) – The value to assign to the compartment_id property of this DbHome.
display_name (str) – The value to assign to the display_name property of this DbHome.
last_patch_history_entry_id (str) – The value to assign to the last_patch_history_entry_id property of this DbHome.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DbHome. 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 DbHome.
vm_cluster_id (str) – The value to assign to the vm_cluster_id property of this DbHome.
db_version (str) – The value to assign to the db_version property of this DbHome.
db_home_location (str) – The value to assign to the db_home_location property of this DbHome.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DbHome.
time_created (datetime) – The value to assign to the time_created property of this DbHome.
kms_key_id (str) – The value to assign to the kms_key_id property of this DbHome.
one_off_patches (list[str]) – The value to assign to the one_off_patches property of this DbHome.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DbHome.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DbHome.
database_software_image_id (str) – The value to assign to the database_software_image_id property of this DbHome.

compartment_id¶

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

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

database_software_image_id¶

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

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

db_home_location¶

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

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

db_system_id¶

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

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

db_version¶

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

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

defined_tags¶

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

display_name¶

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

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

freeform_tags¶

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

id¶

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

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

kms_key_id¶

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

last_patch_history_entry_id¶

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

lifecycle_details¶

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

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

lifecycle_state¶

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

one_off_patches¶

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

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

time_created¶

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

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

vm_cluster_id¶

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

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