DiscoveredCloudDatabase

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

Bases: DiscoveredCloudDbSystemComponent

The details of a cloud Oracle Database discovered in a cloud DB system discovery run.

Attributes:

COMPONENT_TYPE_ASM

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_ASM_INSTANCE

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_CLUSTER

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_CLUSTER_INSTANCE

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_DATABASE

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_DATABASE_HOME

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_DATABASE_INSTANCE

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_DATABASE_NODE

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_DBSYSTEM

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_LISTENER

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_PLUGGABLE_DATABASE

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

DB_ROLE_FAR_SYNC

A constant which can be used with the db_role property of a DiscoveredCloudDatabase.

DB_ROLE_LOGICAL_STANDBY

A constant which can be used with the db_role property of a DiscoveredCloudDatabase.

DB_ROLE_PHYSICAL_STANDBY

A constant which can be used with the db_role property of a DiscoveredCloudDatabase.

DB_ROLE_PRIMARY

A constant which can be used with the db_role property of a DiscoveredCloudDatabase.

DB_ROLE_SNAPSHOT_STANDBY

A constant which can be used with the db_role property of a DiscoveredCloudDatabase.

DB_TYPE_ACD

A constant which can be used with the db_type property of a DiscoveredCloudDatabase.

DB_TYPE_ADB

A constant which can be used with the db_type property of a DiscoveredCloudDatabase.

DB_TYPE_CDB

A constant which can be used with the db_type property of a DiscoveredCloudDatabase.

DB_TYPE_NON_CDB

A constant which can be used with the db_type property of a DiscoveredCloudDatabase.

DB_TYPE_PDB

A constant which can be used with the db_type property of a DiscoveredCloudDatabase.

STATUS_EXISTING

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_EXISTING_BASIC

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_EXISTING_BASIC_PE

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_EXISTING_PE

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_MARKED_FOR_DELETION

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_MARKED_FOR_MIGRATION

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_MARKED_FOR_UPGRADE

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_MARKED_FOR_UPGRADE_MIGRATION

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_NEW

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_UNKNOWN

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

associated_components

Gets the associated_components of this DiscoveredCloudDbSystemComponent.

can_enable_all_current_pdbs

Gets the can_enable_all_current_pdbs of this DiscoveredCloudDatabase.

compartment_id

[Required] Gets the compartment_id of this DiscoveredCloudDatabase.

component_id

[Required] Gets the component_id of this DiscoveredCloudDbSystemComponent.

component_name

[Required] Gets the component_name of this DiscoveredCloudDbSystemComponent.

component_type

[Required] Gets the component_type of this DiscoveredCloudDbSystemComponent.

connector

Gets the connector of this DiscoveredCloudDatabase.

db_edition

Gets the db_edition of this DiscoveredCloudDatabase.

db_id

Gets the db_id of this DiscoveredCloudDatabase.

db_instances

Gets the db_instances of this DiscoveredCloudDatabase.

db_packs

Gets the db_packs of this DiscoveredCloudDatabase.

db_role

Gets the db_role of this DiscoveredCloudDatabase.

db_type

Gets the db_type of this DiscoveredCloudDatabase.

db_unique_name

[Required] Gets the db_unique_name of this DiscoveredCloudDatabase.

db_version

Gets the db_version of this DiscoveredCloudDatabase.

dbaas_id

Gets the dbaas_id of this DiscoveredCloudDbSystemComponent.

display_name

[Required] Gets the display_name of this DiscoveredCloudDbSystemComponent.

is_auto_enable_pluggable_database

Gets the is_auto_enable_pluggable_database of this DiscoveredCloudDatabase.

is_cluster

Gets the is_cluster of this DiscoveredCloudDatabase.

is_selected_for_monitoring

Gets the is_selected_for_monitoring of this DiscoveredCloudDbSystemComponent.

pluggable_databases

Gets the pluggable_databases of this DiscoveredCloudDatabase.

resource_id

Gets the resource_id of this DiscoveredCloudDbSystemComponent.

status

Gets the status of this DiscoveredCloudDbSystemComponent.

Methods:

__init__(**kwargs)

Initializes a new DiscoveredCloudDatabase 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 DiscoveredCloudDbSystemComponent. 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 DiscoveredCloudDbSystemComponent. 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 DiscoveredCloudDbSystemComponent. 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 DiscoveredCloudDbSystemComponent. 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 DiscoveredCloudDbSystemComponent. 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 DiscoveredCloudDbSystemComponent. 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 DiscoveredCloudDbSystemComponent. 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 DiscoveredCloudDbSystemComponent. 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 DiscoveredCloudDbSystemComponent. This constant has a value of “DBSYSTEM”

COMPONENT_TYPE_LISTENER = 'LISTENER'

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent. 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 DiscoveredCloudDbSystemComponent. 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 DiscoveredCloudDatabase. 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 DiscoveredCloudDatabase. 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 DiscoveredCloudDatabase. 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 DiscoveredCloudDatabase. 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 DiscoveredCloudDatabase. 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 DiscoveredCloudDatabase. This constant has a value of “ACD”

DB_TYPE_ADB = 'ADB'

A constant which can be used with the db_type property of a DiscoveredCloudDatabase. This constant has a value of “ADB”

DB_TYPE_CDB = 'CDB'

A constant which can be used with the db_type property of a DiscoveredCloudDatabase. 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 DiscoveredCloudDatabase. 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 DiscoveredCloudDatabase. This constant has a value of “PDB”

STATUS_EXISTING = 'EXISTING'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “EXISTING”

STATUS_EXISTING_BASIC = 'EXISTING_BASIC'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “EXISTING_BASIC”

STATUS_EXISTING_BASIC_PE = 'EXISTING_BASIC_PE'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “EXISTING_BASIC_PE”

STATUS_EXISTING_PE = 'EXISTING_PE'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “EXISTING_PE”

STATUS_MARKED_FOR_DELETION = 'MARKED_FOR_DELETION'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “MARKED_FOR_DELETION”

STATUS_MARKED_FOR_MIGRATION = 'MARKED_FOR_MIGRATION'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “MARKED_FOR_MIGRATION”

STATUS_MARKED_FOR_UPGRADE = 'MARKED_FOR_UPGRADE'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “MARKED_FOR_UPGRADE”

STATUS_MARKED_FOR_UPGRADE_MIGRATION = 'MARKED_FOR_UPGRADE_MIGRATION'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “MARKED_FOR_UPGRADE_MIGRATION”

STATUS_NEW = 'NEW'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “NEW”

STATUS_UNKNOWN = 'UNKNOWN'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “UNKNOWN”

__init__(**kwargs)

Initializes a new DiscoveredCloudDatabase object with values from keyword arguments. The default value of the component_type attribute of this class is DATABASE and 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 DiscoveredCloudDatabase.

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

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

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

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

  • is_selected_for_monitoring (bool) – The value to assign to the is_selected_for_monitoring property of this DiscoveredCloudDatabase.

  • status (str) – The value to assign to the status property of this DiscoveredCloudDatabase. Allowed values for this property are: “NEW”, “EXISTING”, “EXISTING_BASIC”, “EXISTING_PE”, “EXISTING_BASIC_PE”, “MARKED_FOR_UPGRADE”, “MARKED_FOR_MIGRATION”, “MARKED_FOR_UPGRADE_MIGRATION”, “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.AssociatedCloudComponent]) – The value to assign to the associated_components property of this DiscoveredCloudDatabase.

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

  • db_unique_name (str) – The value to assign to the db_unique_name property of this DiscoveredCloudDatabase.

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

  • db_edition (str) – The value to assign to the db_edition property of this DiscoveredCloudDatabase.

  • db_id (str) – The value to assign to the db_id property of this DiscoveredCloudDatabase.

  • db_packs (str) – The value to assign to the db_packs property of this DiscoveredCloudDatabase.

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

  • pluggable_databases (list[oci.database_management.models.DiscoveredCloudPluggableDatabase]) – The value to assign to the pluggable_databases property of this DiscoveredCloudDatabase.

  • db_instances (list[oci.database_management.models.DiscoveredCloudDbInstance]) – The value to assign to the db_instances property of this DiscoveredCloudDatabase.

  • can_enable_all_current_pdbs (bool) – The value to assign to the can_enable_all_current_pdbs property of this DiscoveredCloudDatabase.

  • is_auto_enable_pluggable_database (bool) – The value to assign to the is_auto_enable_pluggable_database property of this DiscoveredCloudDatabase.

  • connector (oci.database_management.models.CloudDbSystemDiscoveryConnector) – The value to assign to the connector property of this DiscoveredCloudDatabase.

property associated_components

Gets the associated_components of this DiscoveredCloudDbSystemComponent. The list of associated components.

Returns

The associated_components of this DiscoveredCloudDbSystemComponent.

Return type

list[oci.database_management.models.AssociatedCloudComponent]

property can_enable_all_current_pdbs

Gets the can_enable_all_current_pdbs of this DiscoveredCloudDatabase. 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 DiscoveredCloudDatabase.

Return type

bool

property compartment_id

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

Returns

The compartment_id of this DiscoveredCloudDatabase.

Return type

str

property component_id

[Required] Gets the component_id of this DiscoveredCloudDbSystemComponent. The identifier of the discovered DB system component.

Returns

The component_id of this DiscoveredCloudDbSystemComponent.

Return type

str

property component_name

[Required] Gets the component_name of this DiscoveredCloudDbSystemComponent. The name of the discovered DB system component.

Returns

The component_name of this DiscoveredCloudDbSystemComponent.

Return type

str

property component_type

[Required] Gets the component_type of this DiscoveredCloudDbSystemComponent. The cloud 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 DiscoveredCloudDbSystemComponent.

Return type

str

property connector

Gets the connector of this DiscoveredCloudDatabase.

Returns

The connector of this DiscoveredCloudDatabase.

Return type

oci.database_management.models.CloudDbSystemDiscoveryConnector

property db_edition

Gets the db_edition of this DiscoveredCloudDatabase. The Oracle Database edition.

Returns

The db_edition of this DiscoveredCloudDatabase.

Return type

str

property db_id

Gets the db_id of this DiscoveredCloudDatabase. The Oracle Database ID.

Returns

The db_id of this DiscoveredCloudDatabase.

Return type

str

property db_instances

Gets the db_instances of this DiscoveredCloudDatabase. The list of database instances.

Returns

The db_instances of this DiscoveredCloudDatabase.

Return type

list[oci.database_management.models.DiscoveredCloudDbInstance]

property db_packs

Gets the db_packs of this DiscoveredCloudDatabase. The database packs licensed for the cloud Oracle Database.

Returns

The db_packs of this DiscoveredCloudDatabase.

Return type

str

property db_role

Gets the db_role of this DiscoveredCloudDatabase. 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 DiscoveredCloudDatabase.

Return type

str

property db_type

Gets the db_type of this DiscoveredCloudDatabase. 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 DiscoveredCloudDatabase.

Return type

str

property db_unique_name

[Required] Gets the db_unique_name of this DiscoveredCloudDatabase. The DB_UNIQUE_NAME of the cloud database.

Returns

The db_unique_name of this DiscoveredCloudDatabase.

Return type

str

property db_version

Gets the db_version of this DiscoveredCloudDatabase. The Oracle Database version.

Returns

The db_version of this DiscoveredCloudDatabase.

Return type

str

property dbaas_id

Gets the dbaas_id of this DiscoveredCloudDbSystemComponent. The OCID of the existing DBaas OCI resource matching the discovered DB system component.

Returns

The dbaas_id of this DiscoveredCloudDbSystemComponent.

Return type

str

property display_name

[Required] Gets the display_name of this DiscoveredCloudDbSystemComponent. The user-friendly name for the discovered DB system component. The name does not have to be unique.

Returns

The display_name of this DiscoveredCloudDbSystemComponent.

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

Return type

bool

property is_cluster

Gets the is_cluster of this DiscoveredCloudDatabase. Indicates whether the Oracle Database is part of a cluster.

Returns

The is_cluster of this DiscoveredCloudDatabase.

Return type

bool

property is_selected_for_monitoring

Gets the is_selected_for_monitoring of this DiscoveredCloudDbSystemComponent. Indicates whether the DB system component should be provisioned as an OCI resource or not.

Returns

The is_selected_for_monitoring of this DiscoveredCloudDbSystemComponent.

Return type

bool

property pluggable_databases

Gets the pluggable_databases of this DiscoveredCloudDatabase. The list of Pluggable Databases.

Returns

The pluggable_databases of this DiscoveredCloudDatabase.

Return type

list[oci.database_management.models.DiscoveredCloudPluggableDatabase]

property resource_id

Gets the resource_id of this DiscoveredCloudDbSystemComponent. The OCID of the existing OCI resource matching the discovered DB system component.

Returns

The resource_id of this DiscoveredCloudDbSystemComponent.

Return type

str

property status

Gets the status of this DiscoveredCloudDbSystemComponent. The state of the discovered DB system component.

Allowed values for this property are: “NEW”, “EXISTING”, “EXISTING_BASIC”, “EXISTING_PE”, “EXISTING_BASIC_PE”, “MARKED_FOR_UPGRADE”, “MARKED_FOR_MIGRATION”, “MARKED_FOR_UPGRADE_MIGRATION”, “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 DiscoveredCloudDbSystemComponent.

Return type

str