CloudDbHome

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

Bases: object

The details of a cloud database home.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a CloudDbHome.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a CloudDbHome.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a CloudDbHome.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a CloudDbHome.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a CloudDbHome.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a CloudDbHome.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a CloudDbHome.

additional_details

Gets the additional_details of this CloudDbHome.

cloud_db_system_id

[Required] Gets the cloud_db_system_id of this CloudDbHome.

compartment_id

[Required] Gets the compartment_id of this CloudDbHome.

component_name

Gets the component_name of this CloudDbHome.

dbaas_id

Gets the dbaas_id of this CloudDbHome.

defined_tags

Gets the defined_tags of this CloudDbHome.

display_name

[Required] Gets the display_name of this CloudDbHome.

freeform_tags

Gets the freeform_tags of this CloudDbHome.

home_directory

Gets the home_directory of this CloudDbHome.

id

[Required] Gets the id of this CloudDbHome.

lifecycle_details

Gets the lifecycle_details of this CloudDbHome.

lifecycle_state

[Required] Gets the lifecycle_state of this CloudDbHome.

system_tags

Gets the system_tags of this CloudDbHome.

time_created

[Required] Gets the time_created of this CloudDbHome.

time_updated

[Required] Gets the time_updated of this CloudDbHome.

Methods:

__init__(**kwargs)

Initializes a new CloudDbHome object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new CloudDbHome 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 CloudDbHome.

  • dbaas_id (str) – The value to assign to the dbaas_id property of this CloudDbHome.

  • display_name (str) – The value to assign to the display_name property of this CloudDbHome.

  • component_name (str) – The value to assign to the component_name property of this CloudDbHome.

  • compartment_id (str) – The value to assign to the compartment_id property of this CloudDbHome.

  • cloud_db_system_id (str) – The value to assign to the cloud_db_system_id property of this CloudDbHome.

  • home_directory (str) – The value to assign to the home_directory property of this CloudDbHome.

  • additional_details (dict(str, str)) – The value to assign to the additional_details property of this CloudDbHome.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this CloudDbHome. 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’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this CloudDbHome.

  • time_created (datetime) – The value to assign to the time_created property of this CloudDbHome.

  • time_updated (datetime) – The value to assign to the time_updated property of this CloudDbHome.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CloudDbHome.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CloudDbHome.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this CloudDbHome.

property additional_details

Gets the additional_details of this CloudDbHome. The additional details of the DB home defined in {“key”: “value”} format. Example: {“bar-key”: “value”}

Returns

The additional_details of this CloudDbHome.

Return type

dict(str, str)

property cloud_db_system_id

[Required] Gets the cloud_db_system_id of this CloudDbHome. The OCID of the cloud DB system that the DB home is a part of.

Returns

The cloud_db_system_id of this CloudDbHome.

Return type

str

property compartment_id

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

Returns

The compartment_id of this CloudDbHome.

Return type

str

property component_name

Gets the component_name of this CloudDbHome. The name of the cloud DB home.

Returns

The component_name of this CloudDbHome.

Return type

str

property dbaas_id

Gets the dbaas_id of this CloudDbHome. The OCID of the cloud DB home in DBaas service.

Returns

The dbaas_id of this CloudDbHome.

Return type

str

property defined_tags

Gets the defined_tags of this CloudDbHome. 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 CloudDbHome.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this CloudDbHome. The user-friendly name for the cloud DB home. The name does not have to be unique.

Returns

The display_name of this CloudDbHome.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property home_directory

Gets the home_directory of this CloudDbHome. The location of the DB home.

Returns

The home_directory of this CloudDbHome.

Return type

str

property id

[Required] Gets the id of this CloudDbHome. The OCID of the cloud DB home.

Returns

The id of this CloudDbHome.

Return type

str

property lifecycle_details

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

Returns

The lifecycle_details of this CloudDbHome.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this CloudDbHome. The current lifecycle state of the cloud DB home.

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 CloudDbHome.

Return type

str

property system_tags

Gets the system_tags of this CloudDbHome. 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 CloudDbHome.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this CloudDbHome. The date and time the cloud DB home was created.

Returns

The time_created of this CloudDbHome.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this CloudDbHome. The date and time the cloud DB home was last updated.

Returns

The time_updated of this CloudDbHome.

Return type

datetime