ExternalClusterSummary¶
- class oci.database_management.models.ExternalClusterSummary(**kwargs)¶
Bases:
objectThe summary of an external cluster.
Methods:
__init__(**kwargs)Initializes a new ExternalClusterSummary object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this ExternalClusterSummary.
[Required] Gets the component_name of this ExternalClusterSummary.
Gets the defined_tags of this ExternalClusterSummary.
[Required] Gets the display_name of this ExternalClusterSummary.
Gets the external_connector_id of this ExternalClusterSummary.
[Required] Gets the external_db_system_id of this ExternalClusterSummary.
Gets the freeform_tags of this ExternalClusterSummary.
[Required] Gets the id of this ExternalClusterSummary.
Gets the lifecycle_details of this ExternalClusterSummary.
[Required] Gets the lifecycle_state of this ExternalClusterSummary.
Gets the system_tags of this ExternalClusterSummary.
[Required] Gets the time_created of this ExternalClusterSummary.
[Required] Gets the time_updated of this ExternalClusterSummary.
- __init__(**kwargs)¶
Initializes a new ExternalClusterSummary 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 ExternalClusterSummary.
display_name (str) – The value to assign to the display_name property of this ExternalClusterSummary.
component_name (str) – The value to assign to the component_name property of this ExternalClusterSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ExternalClusterSummary.
external_db_system_id (str) – The value to assign to the external_db_system_id property of this ExternalClusterSummary.
external_connector_id (str) – The value to assign to the external_connector_id property of this ExternalClusterSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ExternalClusterSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ExternalClusterSummary.
time_created (datetime) – The value to assign to the time_created property of this ExternalClusterSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ExternalClusterSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ExternalClusterSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ExternalClusterSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ExternalClusterSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this ExternalClusterSummary. The OCID of the compartment.
- Returns
The compartment_id of this ExternalClusterSummary.
- Return type
str
- property component_name¶
[Required] Gets the component_name of this ExternalClusterSummary. The name of the external cluster.
- Returns
The component_name of this ExternalClusterSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this ExternalClusterSummary. 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 ExternalClusterSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this ExternalClusterSummary. The user-friendly name for the external cluster. The name does not have to be unique.
- Returns
The display_name of this ExternalClusterSummary.
- Return type
str
- property external_connector_id¶
Gets the external_connector_id of this ExternalClusterSummary. The OCID of the external connector.
- Returns
The external_connector_id of this ExternalClusterSummary.
- Return type
str
- property external_db_system_id¶
[Required] Gets the external_db_system_id of this ExternalClusterSummary. The OCID of the external DB system that the cluster is a part of.
- Returns
The external_db_system_id of this ExternalClusterSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this ExternalClusterSummary. 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 ExternalClusterSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this ExternalClusterSummary. The OCID of the external cluster.
- Returns
The id of this ExternalClusterSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this ExternalClusterSummary. Additional information about the current lifecycle state.
- Returns
The lifecycle_details of this ExternalClusterSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this ExternalClusterSummary. The current lifecycle state of the external cluster.
- Returns
The lifecycle_state of this ExternalClusterSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this ExternalClusterSummary. 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 ExternalClusterSummary.
- Return type
dict(str, dict(str, object))
- property time_created¶
[Required] Gets the time_created of this ExternalClusterSummary. The date and time the external cluster was created.
- Returns
The time_created of this ExternalClusterSummary.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this ExternalClusterSummary. The date and time the external cluster was last updated.
- Returns
The time_updated of this ExternalClusterSummary.
- Return type
datetime