ExternalClusterInstanceSummary¶
- class oci.database_management.models.ExternalClusterInstanceSummary(**kwargs)¶
Bases:
objectThe summary of an external cluster instance.
Methods:
__init__(**kwargs)Initializes a new ExternalClusterInstanceSummary object with values from keyword arguments.
Attributes:
Gets the adr_home_directory of this ExternalClusterInstanceSummary.
[Required] Gets the compartment_id of this ExternalClusterInstanceSummary.
[Required] Gets the component_name of this ExternalClusterInstanceSummary.
Gets the crs_base_directory of this ExternalClusterInstanceSummary.
Gets the defined_tags of this ExternalClusterInstanceSummary.
[Required] Gets the display_name of this ExternalClusterInstanceSummary.
[Required] Gets the external_cluster_id of this ExternalClusterInstanceSummary.
Gets the external_connector_id of this ExternalClusterInstanceSummary.
Gets the external_db_node_id of this ExternalClusterInstanceSummary.
[Required] Gets the external_db_system_id of this ExternalClusterInstanceSummary.
Gets the freeform_tags of this ExternalClusterInstanceSummary.
Gets the host_name of this ExternalClusterInstanceSummary.
[Required] Gets the id of this ExternalClusterInstanceSummary.
Gets the lifecycle_details of this ExternalClusterInstanceSummary.
[Required] Gets the lifecycle_state of this ExternalClusterInstanceSummary.
Gets the node_role of this ExternalClusterInstanceSummary.
Gets the system_tags of this ExternalClusterInstanceSummary.
Gets the time_created of this ExternalClusterInstanceSummary.
Gets the time_updated of this ExternalClusterInstanceSummary.
- __init__(**kwargs)¶
Initializes a new ExternalClusterInstanceSummary 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 ExternalClusterInstanceSummary.
display_name (str) – The value to assign to the display_name property of this ExternalClusterInstanceSummary.
component_name (str) – The value to assign to the component_name property of this ExternalClusterInstanceSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ExternalClusterInstanceSummary.
external_cluster_id (str) – The value to assign to the external_cluster_id property of this ExternalClusterInstanceSummary.
external_db_system_id (str) – The value to assign to the external_db_system_id property of this ExternalClusterInstanceSummary.
external_db_node_id (str) – The value to assign to the external_db_node_id property of this ExternalClusterInstanceSummary.
external_connector_id (str) – The value to assign to the external_connector_id property of this ExternalClusterInstanceSummary.
host_name (str) – The value to assign to the host_name property of this ExternalClusterInstanceSummary.
node_role (str) – The value to assign to the node_role property of this ExternalClusterInstanceSummary.
crs_base_directory (str) – The value to assign to the crs_base_directory property of this ExternalClusterInstanceSummary.
adr_home_directory (str) – The value to assign to the adr_home_directory property of this ExternalClusterInstanceSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ExternalClusterInstanceSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ExternalClusterInstanceSummary.
time_created (datetime) – The value to assign to the time_created property of this ExternalClusterInstanceSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ExternalClusterInstanceSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ExternalClusterInstanceSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ExternalClusterInstanceSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ExternalClusterInstanceSummary.
- property adr_home_directory¶
Gets the adr_home_directory of this ExternalClusterInstanceSummary. The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
- Returns
The adr_home_directory of this ExternalClusterInstanceSummary.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this ExternalClusterInstanceSummary. The OCID of the compartment.
- Returns
The compartment_id of this ExternalClusterInstanceSummary.
- Return type
str
- property component_name¶
[Required] Gets the component_name of this ExternalClusterInstanceSummary. The name of the external cluster instance.
- Returns
The component_name of this ExternalClusterInstanceSummary.
- Return type
str
- property crs_base_directory¶
Gets the crs_base_directory of this ExternalClusterInstanceSummary. The Oracle base location of Cluster Ready Services (CRS).
- Returns
The crs_base_directory of this ExternalClusterInstanceSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this ExternalClusterInstanceSummary. 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 ExternalClusterInstanceSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this ExternalClusterInstanceSummary. The user-friendly name for the cluster instance. The name does not have to be unique.
- Returns
The display_name of this ExternalClusterInstanceSummary.
- Return type
str
- property external_cluster_id¶
[Required] Gets the external_cluster_id of this ExternalClusterInstanceSummary. The OCID of the external cluster that the cluster instance belongs to.
- Returns
The external_cluster_id of this ExternalClusterInstanceSummary.
- Return type
str
- property external_connector_id¶
Gets the external_connector_id of this ExternalClusterInstanceSummary. The OCID of the external connector.
- Returns
The external_connector_id of this ExternalClusterInstanceSummary.
- Return type
str
- property external_db_node_id¶
Gets the external_db_node_id of this ExternalClusterInstanceSummary. The OCID of the external DB node.
- Returns
The external_db_node_id of this ExternalClusterInstanceSummary.
- Return type
str
- property external_db_system_id¶
[Required] Gets the external_db_system_id of this ExternalClusterInstanceSummary. The OCID of the external DB system that the cluster instance is a part of.
- Returns
The external_db_system_id of this ExternalClusterInstanceSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this ExternalClusterInstanceSummary. 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 ExternalClusterInstanceSummary.
- Return type
dict(str, str)
- property host_name¶
Gets the host_name of this ExternalClusterInstanceSummary. The name of the host on which the cluster instance is running.
- Returns
The host_name of this ExternalClusterInstanceSummary.
- Return type
str
- property id¶
[Required] Gets the id of this ExternalClusterInstanceSummary. The OCID of the external cluster instance.
- Returns
The id of this ExternalClusterInstanceSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this ExternalClusterInstanceSummary. Additional information about the current lifecycle state.
- Returns
The lifecycle_details of this ExternalClusterInstanceSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this ExternalClusterInstanceSummary. The current lifecycle state of the external cluster instance.
- Returns
The lifecycle_state of this ExternalClusterInstanceSummary.
- Return type
str
- property node_role¶
Gets the node_role of this ExternalClusterInstanceSummary. The role of the cluster node.
- Returns
The node_role of this ExternalClusterInstanceSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this ExternalClusterInstanceSummary. 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 ExternalClusterInstanceSummary.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this ExternalClusterInstanceSummary. The date and time the external cluster instance was created.
- Returns
The time_created of this ExternalClusterInstanceSummary.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this ExternalClusterInstanceSummary. The date and time the external cluster instance was last updated.
- Returns
The time_updated of this ExternalClusterInstanceSummary.
- Return type
datetime