DiscoveredExternalDatabase¶
- class oci.database_management.models.DiscoveredExternalDatabase(**kwargs)¶
Bases:
DiscoveredExternalDbSystemComponentThe details of an external Oracle Database discovered in an external DB system discovery run.
Attributes:
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent.
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent.
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent.
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent.
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent.
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent.
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent.
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent.
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent.
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent.
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent.
A constant which can be used with the db_role property of a DiscoveredExternalDatabase.
A constant which can be used with the db_role property of a DiscoveredExternalDatabase.
A constant which can be used with the db_role property of a DiscoveredExternalDatabase.
A constant which can be used with the db_role property of a DiscoveredExternalDatabase.
A constant which can be used with the db_role property of a DiscoveredExternalDatabase.
A constant which can be used with the db_type property of a DiscoveredExternalDatabase.
A constant which can be used with the db_type property of a DiscoveredExternalDatabase.
A constant which can be used with the db_type property of a DiscoveredExternalDatabase.
A constant which can be used with the db_type property of a DiscoveredExternalDatabase.
A constant which can be used with the db_type property of a DiscoveredExternalDatabase.
A constant which can be used with the status property of a DiscoveredExternalDbSystemComponent.
A constant which can be used with the status property of a DiscoveredExternalDbSystemComponent.
A constant which can be used with the status property of a DiscoveredExternalDbSystemComponent.
A constant which can be used with the status property of a DiscoveredExternalDbSystemComponent.
Gets the associated_components of this DiscoveredExternalDbSystemComponent.
Gets the can_enable_all_current_pdbs of this DiscoveredExternalDatabase.
[Required] Gets the compartment_id of this DiscoveredExternalDatabase.
[Required] Gets the component_id of this DiscoveredExternalDbSystemComponent.
[Required] Gets the component_name of this DiscoveredExternalDbSystemComponent.
[Required] Gets the component_type of this DiscoveredExternalDbSystemComponent.
Gets the connector of this DiscoveredExternalDatabase.
Gets the db_edition of this DiscoveredExternalDatabase.
Gets the db_id of this DiscoveredExternalDatabase.
Gets the db_instances of this DiscoveredExternalDatabase.
Gets the db_packs of this DiscoveredExternalDatabase.
Gets the db_role of this DiscoveredExternalDatabase.
Gets the db_type of this DiscoveredExternalDatabase.
[Required] Gets the db_unique_name of this DiscoveredExternalDatabase.
Gets the db_version of this DiscoveredExternalDatabase.
[Required] Gets the display_name of this DiscoveredExternalDbSystemComponent.
Gets the is_auto_enable_pluggable_database of this DiscoveredExternalDatabase.
Gets the is_cluster of this DiscoveredExternalDatabase.
Gets the is_selected_for_monitoring of this DiscoveredExternalDbSystemComponent.
Gets the pluggable_databases of this DiscoveredExternalDatabase.
Gets the resource_id of this DiscoveredExternalDbSystemComponent.
Gets the status of this DiscoveredExternalDbSystemComponent.
Methods:
__init__(**kwargs)Initializes a new DiscoveredExternalDatabase object with values from keyword arguments.
get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- COMPONENT_TYPE_ASM = 'ASM'¶
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent. This constant has a value of “ASM”
- COMPONENT_TYPE_ASM_INSTANCE = 'ASM_INSTANCE'¶
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent. This constant has a value of “ASM_INSTANCE”
- COMPONENT_TYPE_CLUSTER = 'CLUSTER'¶
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent. This constant has a value of “CLUSTER”
- COMPONENT_TYPE_CLUSTER_INSTANCE = 'CLUSTER_INSTANCE'¶
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent. This constant has a value of “CLUSTER_INSTANCE”
- COMPONENT_TYPE_DATABASE = 'DATABASE'¶
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent. This constant has a value of “DATABASE”
- COMPONENT_TYPE_DATABASE_HOME = 'DATABASE_HOME'¶
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent. This constant has a value of “DATABASE_HOME”
- COMPONENT_TYPE_DATABASE_INSTANCE = 'DATABASE_INSTANCE'¶
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent. This constant has a value of “DATABASE_INSTANCE”
- COMPONENT_TYPE_DATABASE_NODE = 'DATABASE_NODE'¶
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent. This constant has a value of “DATABASE_NODE”
- COMPONENT_TYPE_DBSYSTEM = 'DBSYSTEM'¶
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent. This constant has a value of “DBSYSTEM”
- COMPONENT_TYPE_LISTENER = 'LISTENER'¶
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent. This constant has a value of “LISTENER”
- COMPONENT_TYPE_PLUGGABLE_DATABASE = 'PLUGGABLE_DATABASE'¶
A constant which can be used with the component_type property of a DiscoveredExternalDbSystemComponent. This constant has a value of “PLUGGABLE_DATABASE”
- DB_ROLE_FAR_SYNC = 'FAR_SYNC'¶
A constant which can be used with the db_role property of a DiscoveredExternalDatabase. This constant has a value of “FAR_SYNC”
- DB_ROLE_LOGICAL_STANDBY = 'LOGICAL_STANDBY'¶
A constant which can be used with the db_role property of a DiscoveredExternalDatabase. This constant has a value of “LOGICAL_STANDBY”
- DB_ROLE_PHYSICAL_STANDBY = 'PHYSICAL_STANDBY'¶
A constant which can be used with the db_role property of a DiscoveredExternalDatabase. This constant has a value of “PHYSICAL_STANDBY”
- DB_ROLE_PRIMARY = 'PRIMARY'¶
A constant which can be used with the db_role property of a DiscoveredExternalDatabase. This constant has a value of “PRIMARY”
- DB_ROLE_SNAPSHOT_STANDBY = 'SNAPSHOT_STANDBY'¶
A constant which can be used with the db_role property of a DiscoveredExternalDatabase. This constant has a value of “SNAPSHOT_STANDBY”
- DB_TYPE_ACD = 'ACD'¶
A constant which can be used with the db_type property of a DiscoveredExternalDatabase. This constant has a value of “ACD”
- DB_TYPE_ADB = 'ADB'¶
A constant which can be used with the db_type property of a DiscoveredExternalDatabase. This constant has a value of “ADB”
- DB_TYPE_CDB = 'CDB'¶
A constant which can be used with the db_type property of a DiscoveredExternalDatabase. This constant has a value of “CDB”
- DB_TYPE_NON_CDB = 'NON_CDB'¶
A constant which can be used with the db_type property of a DiscoveredExternalDatabase. This constant has a value of “NON_CDB”
- DB_TYPE_PDB = 'PDB'¶
A constant which can be used with the db_type property of a DiscoveredExternalDatabase. This constant has a value of “PDB”
- STATUS_EXISTING = 'EXISTING'¶
A constant which can be used with the status property of a DiscoveredExternalDbSystemComponent. This constant has a value of “EXISTING”
- STATUS_MARKED_FOR_DELETION = 'MARKED_FOR_DELETION'¶
A constant which can be used with the status property of a DiscoveredExternalDbSystemComponent. This constant has a value of “MARKED_FOR_DELETION”
- STATUS_NEW = 'NEW'¶
A constant which can be used with the status property of a DiscoveredExternalDbSystemComponent. This constant has a value of “NEW”
- STATUS_UNKNOWN = 'UNKNOWN'¶
A constant which can be used with the status property of a DiscoveredExternalDbSystemComponent. This constant has a value of “UNKNOWN”
- __init__(**kwargs)¶
Initializes a new DiscoveredExternalDatabase object with values from keyword arguments. The default value of the
component_typeattribute of this class isDATABASEand it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):- Parameters
component_id (str) – The value to assign to the component_id property of this DiscoveredExternalDatabase.
display_name (str) – The value to assign to the display_name property of this DiscoveredExternalDatabase.
component_name (str) – The value to assign to the component_name property of this DiscoveredExternalDatabase.
component_type (str) – The value to assign to the component_type property of this DiscoveredExternalDatabase. Allowed values for this property are: “ASM”, “ASM_INSTANCE”, “CLUSTER”, “CLUSTER_INSTANCE”, “DATABASE”, “DATABASE_INSTANCE”, “DATABASE_HOME”, “DATABASE_NODE”, “DBSYSTEM”, “LISTENER”, “PLUGGABLE_DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
resource_id (str) – The value to assign to the resource_id property of this DiscoveredExternalDatabase.
is_selected_for_monitoring (bool) – The value to assign to the is_selected_for_monitoring property of this DiscoveredExternalDatabase.
status (str) – The value to assign to the status property of this DiscoveredExternalDatabase. Allowed values for this property are: “NEW”, “EXISTING”, “MARKED_FOR_DELETION”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
associated_components (list[oci.database_management.models.AssociatedComponent]) – The value to assign to the associated_components property of this DiscoveredExternalDatabase.
compartment_id (str) – The value to assign to the compartment_id property of this DiscoveredExternalDatabase.
db_unique_name (str) – The value to assign to the db_unique_name property of this DiscoveredExternalDatabase.
db_type (str) – The value to assign to the db_type property of this DiscoveredExternalDatabase. Allowed values for this property are: “CDB”, “PDB”, “NON_CDB”, “ACD”, “ADB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_cluster (bool) – The value to assign to the is_cluster property of this DiscoveredExternalDatabase.
db_edition (str) – The value to assign to the db_edition property of this DiscoveredExternalDatabase.
db_id (str) – The value to assign to the db_id property of this DiscoveredExternalDatabase.
db_packs (str) – The value to assign to the db_packs property of this DiscoveredExternalDatabase.
db_role (str) – The value to assign to the db_role property of this DiscoveredExternalDatabase. Allowed values for this property are: “LOGICAL_STANDBY”, “PHYSICAL_STANDBY”, “SNAPSHOT_STANDBY”, “PRIMARY”, “FAR_SYNC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
db_version (str) – The value to assign to the db_version property of this DiscoveredExternalDatabase.
pluggable_databases (list[oci.database_management.models.DiscoveredExternalPluggableDatabase]) – The value to assign to the pluggable_databases property of this DiscoveredExternalDatabase.
db_instances (list[oci.database_management.models.DiscoveredExternalDbInstance]) – The value to assign to the db_instances property of this DiscoveredExternalDatabase.
connector (oci.database_management.models.ExternalDbSystemDiscoveryConnector) – The value to assign to the connector property of this DiscoveredExternalDatabase.
can_enable_all_current_pdbs (bool) – The value to assign to the can_enable_all_current_pdbs property of this DiscoveredExternalDatabase.
is_auto_enable_pluggable_database (bool) – The value to assign to the is_auto_enable_pluggable_database property of this DiscoveredExternalDatabase.
- property associated_components¶
Gets the associated_components of this DiscoveredExternalDbSystemComponent. The list of associated components.
- Returns
The associated_components of this DiscoveredExternalDbSystemComponent.
- Return type
- property can_enable_all_current_pdbs¶
Gets the can_enable_all_current_pdbs of this DiscoveredExternalDatabase. Indicates whether Diagnostics & Management should be enabled for all the current pluggable databases in the container database.
- Returns
The can_enable_all_current_pdbs of this DiscoveredExternalDatabase.
- Return type
bool
- property compartment_id¶
[Required] Gets the compartment_id of this DiscoveredExternalDatabase. The OCID of the compartment.
- Returns
The compartment_id of this DiscoveredExternalDatabase.
- Return type
str
- property component_id¶
[Required] Gets the component_id of this DiscoveredExternalDbSystemComponent. The identifier of the discovered DB system component.
- Returns
The component_id of this DiscoveredExternalDbSystemComponent.
- Return type
str
- property component_name¶
[Required] Gets the component_name of this DiscoveredExternalDbSystemComponent. The name of the discovered DB system component.
- Returns
The component_name of this DiscoveredExternalDbSystemComponent.
- Return type
str
- property component_type¶
[Required] Gets the component_type of this DiscoveredExternalDbSystemComponent. The external DB system component type.
Allowed values for this property are: “ASM”, “ASM_INSTANCE”, “CLUSTER”, “CLUSTER_INSTANCE”, “DATABASE”, “DATABASE_INSTANCE”, “DATABASE_HOME”, “DATABASE_NODE”, “DBSYSTEM”, “LISTENER”, “PLUGGABLE_DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The component_type of this DiscoveredExternalDbSystemComponent.
- Return type
str
- property connector¶
Gets the connector of this DiscoveredExternalDatabase.
- Returns
The connector of this DiscoveredExternalDatabase.
- Return type
oci.database_management.models.ExternalDbSystemDiscoveryConnector
- property db_edition¶
Gets the db_edition of this DiscoveredExternalDatabase. The Oracle Database edition.
- Returns
The db_edition of this DiscoveredExternalDatabase.
- Return type
str
- property db_id¶
Gets the db_id of this DiscoveredExternalDatabase. The Oracle Database ID.
- Returns
The db_id of this DiscoveredExternalDatabase.
- Return type
str
- property db_instances¶
Gets the db_instances of this DiscoveredExternalDatabase. The list of database instances.
- Returns
The db_instances of this DiscoveredExternalDatabase.
- Return type
list[oci.database_management.models.DiscoveredExternalDbInstance]
- property db_packs¶
Gets the db_packs of this DiscoveredExternalDatabase. The database packs licensed for the external Oracle Database.
- Returns
The db_packs of this DiscoveredExternalDatabase.
- Return type
str
- property db_role¶
Gets the db_role of this DiscoveredExternalDatabase. The role of the Oracle Database in Oracle Data Guard configuration.
Allowed values for this property are: “LOGICAL_STANDBY”, “PHYSICAL_STANDBY”, “SNAPSHOT_STANDBY”, “PRIMARY”, “FAR_SYNC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The db_role of this DiscoveredExternalDatabase.
- Return type
str
- property db_type¶
Gets the db_type of this DiscoveredExternalDatabase. The type of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database.
Allowed values for this property are: “CDB”, “PDB”, “NON_CDB”, “ACD”, “ADB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The db_type of this DiscoveredExternalDatabase.
- Return type
str
- property db_unique_name¶
[Required] Gets the db_unique_name of this DiscoveredExternalDatabase. The DB_UNIQUE_NAME of the external database.
- Returns
The db_unique_name of this DiscoveredExternalDatabase.
- Return type
str
- property db_version¶
Gets the db_version of this DiscoveredExternalDatabase. The Oracle Database version.
- Returns
The db_version of this DiscoveredExternalDatabase.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this DiscoveredExternalDbSystemComponent. The user-friendly name for the discovered DB system component. The name does not have to be unique.
- Returns
The display_name of this DiscoveredExternalDbSystemComponent.
- Return type
str
- static get_subtype(object_dictionary)¶
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- property is_auto_enable_pluggable_database¶
Gets the is_auto_enable_pluggable_database of this DiscoveredExternalDatabase. Indicates whether Diagnostics & Management should be enabled automatically for all the pluggable databases in the container database.
- Returns
The is_auto_enable_pluggable_database of this DiscoveredExternalDatabase.
- Return type
bool
- property is_cluster¶
Gets the is_cluster of this DiscoveredExternalDatabase. Indicates whether the Oracle Database is part of a cluster.
- Returns
The is_cluster of this DiscoveredExternalDatabase.
- Return type
bool
- property is_selected_for_monitoring¶
Gets the is_selected_for_monitoring of this DiscoveredExternalDbSystemComponent. Indicates whether the DB system component should be provisioned as an OCI resource or not.
- Returns
The is_selected_for_monitoring of this DiscoveredExternalDbSystemComponent.
- Return type
bool
- property pluggable_databases¶
Gets the pluggable_databases of this DiscoveredExternalDatabase. The list of Pluggable Databases.
- Returns
The pluggable_databases of this DiscoveredExternalDatabase.
- Return type
list[oci.database_management.models.DiscoveredExternalPluggableDatabase]
- property resource_id¶
Gets the resource_id of this DiscoveredExternalDbSystemComponent. The OCID of the existing OCI resource matching the discovered DB system component.
- Returns
The resource_id of this DiscoveredExternalDbSystemComponent.
- Return type
str
- property status¶
Gets the status of this DiscoveredExternalDbSystemComponent. The state of the discovered DB system component.
Allowed values for this property are: “NEW”, “EXISTING”, “MARKED_FOR_DELETION”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The status of this DiscoveredExternalDbSystemComponent.
- Return type
str