DiscoveredCloudClusterInstance

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

Bases: DiscoveredCloudDbSystemComponent

The details of a cloud cluster instance 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.

NODE_ROLE_HUB

A constant which can be used with the node_role property of a DiscoveredCloudClusterInstance.

NODE_ROLE_LEAF

A constant which can be used with the node_role property of a DiscoveredCloudClusterInstance.

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.

adr_home_directory

Gets the adr_home_directory of this DiscoveredCloudClusterInstance.

associated_components

Gets the associated_components of this DiscoveredCloudDbSystemComponent.

cluster_id

Gets the cluster_id of this DiscoveredCloudClusterInstance.

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

crs_base_directory

Gets the crs_base_directory of this DiscoveredCloudClusterInstance.

dbaas_id

Gets the dbaas_id of this DiscoveredCloudDbSystemComponent.

display_name

[Required] Gets the display_name of this DiscoveredCloudDbSystemComponent.

host_name

[Required] Gets the host_name of this DiscoveredCloudClusterInstance.

is_selected_for_monitoring

Gets the is_selected_for_monitoring of this DiscoveredCloudDbSystemComponent.

node_role

Gets the node_role of this DiscoveredCloudClusterInstance.

resource_id

Gets the resource_id of this DiscoveredCloudDbSystemComponent.

status

Gets the status of this DiscoveredCloudDbSystemComponent.

Methods:

__init__(**kwargs)

Initializes a new DiscoveredCloudClusterInstance 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”

NODE_ROLE_HUB = 'HUB'

A constant which can be used with the node_role property of a DiscoveredCloudClusterInstance. This constant has a value of “HUB”

NODE_ROLE_LEAF = 'LEAF'

A constant which can be used with the node_role property of a DiscoveredCloudClusterInstance. This constant has a value of “LEAF”

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 DiscoveredCloudClusterInstance object with values from keyword arguments. The default value of the component_type attribute of this class is CLUSTER_INSTANCE 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 DiscoveredCloudClusterInstance.

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

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

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

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

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

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

  • host_name (str) – The value to assign to the host_name property of this DiscoveredCloudClusterInstance.

  • cluster_id (str) – The value to assign to the cluster_id property of this DiscoveredCloudClusterInstance.

  • node_role (str) – The value to assign to the node_role property of this DiscoveredCloudClusterInstance. Allowed values for this property are: “HUB”, “LEAF”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • crs_base_directory (str) – The value to assign to the crs_base_directory property of this DiscoveredCloudClusterInstance.

  • adr_home_directory (str) – The value to assign to the adr_home_directory property of this DiscoveredCloudClusterInstance.

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

property adr_home_directory

Gets the adr_home_directory of this DiscoveredCloudClusterInstance. The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.

Returns

The adr_home_directory of this DiscoveredCloudClusterInstance.

Return type

str

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 cluster_id

Gets the cluster_id of this DiscoveredCloudClusterInstance. The unique identifier of the Oracle cluster.

Returns

The cluster_id of this DiscoveredCloudClusterInstance.

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

Returns

The connector of this DiscoveredCloudClusterInstance.

Return type

oci.database_management.models.CloudDbSystemDiscoveryConnector

property crs_base_directory

Gets the crs_base_directory of this DiscoveredCloudClusterInstance. The Oracle base location of Cluster Ready Services (CRS).

Returns

The crs_base_directory of this DiscoveredCloudClusterInstance.

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 host_name

[Required] Gets the host_name of this DiscoveredCloudClusterInstance. The name of the host on which the cluster instance is running.

Returns

The host_name of this DiscoveredCloudClusterInstance.

Return type

str

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 node_role

Gets the node_role of this DiscoveredCloudClusterInstance. The role of the cluster node.

Allowed values for this property are: “HUB”, “LEAF”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The node_role of this DiscoveredCloudClusterInstance.

Return type

str

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