ExternalDbHome

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

Bases: object

The details of an external database home.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a ExternalDbHome.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a ExternalDbHome.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a ExternalDbHome.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a ExternalDbHome.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a ExternalDbHome.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a ExternalDbHome.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a ExternalDbHome.
additional_details Gets the additional_details of this ExternalDbHome.
compartment_id [Required] Gets the compartment_id of this ExternalDbHome.
component_name Gets the component_name of this ExternalDbHome.
defined_tags Gets the defined_tags of this ExternalDbHome.
display_name [Required] Gets the display_name of this ExternalDbHome.
external_db_system_id [Required] Gets the external_db_system_id of this ExternalDbHome.
freeform_tags Gets the freeform_tags of this ExternalDbHome.
home_directory Gets the home_directory of this ExternalDbHome.
id [Required] Gets the id of this ExternalDbHome.
lifecycle_details Gets the lifecycle_details of this ExternalDbHome.
lifecycle_state [Required] Gets the lifecycle_state of this ExternalDbHome.
system_tags Gets the system_tags of this ExternalDbHome.
time_created [Required] Gets the time_created of this ExternalDbHome.
time_updated [Required] Gets the time_updated of this ExternalDbHome.

Methods

__init__(**kwargs) Initializes a new ExternalDbHome object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new ExternalDbHome 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 ExternalDbHome.
  • display_name (str) – The value to assign to the display_name property of this ExternalDbHome.
  • component_name (str) – The value to assign to the component_name property of this ExternalDbHome.
  • compartment_id (str) – The value to assign to the compartment_id property of this ExternalDbHome.
  • external_db_system_id (str) – The value to assign to the external_db_system_id property of this ExternalDbHome.
  • home_directory (str) – The value to assign to the home_directory property of this ExternalDbHome.
  • additional_details (dict(str, str)) – The value to assign to the additional_details property of this ExternalDbHome.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this ExternalDbHome. 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 ExternalDbHome.
  • time_created (datetime) – The value to assign to the time_created property of this ExternalDbHome.
  • time_updated (datetime) – The value to assign to the time_updated property of this ExternalDbHome.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ExternalDbHome.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ExternalDbHome.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ExternalDbHome.
additional_details

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

Returns:The additional_details of this ExternalDbHome.
Return type:dict(str, str)
compartment_id

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

Returns:The compartment_id of this ExternalDbHome.
Return type:str
component_name

Gets the component_name of this ExternalDbHome. The name of the external DB home.

Returns:The component_name of this ExternalDbHome.
Return type:str
defined_tags

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

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

Returns:The display_name of this ExternalDbHome.
Return type:str
external_db_system_id

[Required] Gets the external_db_system_id of this ExternalDbHome. The OCID of the external DB system that the DB home is a part of.

Returns:The external_db_system_id of this ExternalDbHome.
Return type:str
freeform_tags

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

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

Returns:The home_directory of this ExternalDbHome.
Return type:str
id

[Required] Gets the id of this ExternalDbHome. The OCID of the external DB home.

Returns:The id of this ExternalDbHome.
Return type:str
lifecycle_details

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

Returns:The lifecycle_details of this ExternalDbHome.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this ExternalDbHome. The current lifecycle state of the external 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 ExternalDbHome.
Return type:str
system_tags

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

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

Returns:The time_created of this ExternalDbHome.
Return type:datetime
time_updated

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

Returns:The time_updated of this ExternalDbHome.
Return type:datetime