DatabaseInsightSummary¶
- class oci.opsi.models.DatabaseInsightSummary(**kwargs)¶
Bases:
objectSummary of a database insight resource.
Attributes:
A constant which can be used with the entity_source property of a DatabaseInsightSummary.
A constant which can be used with the entity_source property of a DatabaseInsightSummary.
A constant which can be used with the entity_source property of a DatabaseInsightSummary.
A constant which can be used with the entity_source property of a DatabaseInsightSummary.
A constant which can be used with the entity_source property of a DatabaseInsightSummary.
A constant which can be used with the entity_source property of a DatabaseInsightSummary.
A constant which can be used with the entity_source property of a DatabaseInsightSummary.
A constant which can be used with the entity_source property of a DatabaseInsightSummary.
A constant which can be used with the lifecycle_state property of a DatabaseInsightSummary.
A constant which can be used with the lifecycle_state property of a DatabaseInsightSummary.
A constant which can be used with the lifecycle_state property of a DatabaseInsightSummary.
A constant which can be used with the lifecycle_state property of a DatabaseInsightSummary.
A constant which can be used with the lifecycle_state property of a DatabaseInsightSummary.
A constant which can be used with the lifecycle_state property of a DatabaseInsightSummary.
A constant which can be used with the lifecycle_state property of a DatabaseInsightSummary.
A constant which can be used with the status property of a DatabaseInsightSummary.
A constant which can be used with the status property of a DatabaseInsightSummary.
A constant which can be used with the status property of a DatabaseInsightSummary.
Gets the compartment_id of this DatabaseInsightSummary.
Gets the database_connection_status_details of this DatabaseInsightSummary.
Gets the database_display_name of this DatabaseInsightSummary.
Gets the database_host_names of this DatabaseInsightSummary.
[Required] Gets the database_id of this DatabaseInsightSummary.
Gets the database_name of this DatabaseInsightSummary.
Gets the database_type of this DatabaseInsightSummary.
Gets the database_version of this DatabaseInsightSummary.
Gets the defined_tags of this DatabaseInsightSummary.
[Required] Gets the entity_source of this DatabaseInsightSummary.
Gets the freeform_tags of this DatabaseInsightSummary.
[Required] Gets the id of this DatabaseInsightSummary.
Gets the lifecycle_details of this DatabaseInsightSummary.
Gets the lifecycle_state of this DatabaseInsightSummary.
Gets the processor_count of this DatabaseInsightSummary.
Gets the status of this DatabaseInsightSummary.
Gets the system_tags of this DatabaseInsightSummary.
Gets the time_created of this DatabaseInsightSummary.
Gets the time_updated of this DatabaseInsightSummary.
Methods:
__init__(**kwargs)Initializes a new DatabaseInsightSummary 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.
- ENTITY_SOURCE_AUTONOMOUS_DATABASE = 'AUTONOMOUS_DATABASE'¶
A constant which can be used with the entity_source property of a DatabaseInsightSummary. This constant has a value of “AUTONOMOUS_DATABASE”
- ENTITY_SOURCE_EM_MANAGED_EXTERNAL_DATABASE = 'EM_MANAGED_EXTERNAL_DATABASE'¶
A constant which can be used with the entity_source property of a DatabaseInsightSummary. This constant has a value of “EM_MANAGED_EXTERNAL_DATABASE”
- ENTITY_SOURCE_EXTERNAL_MYSQL_DATABASE_SYSTEM = 'EXTERNAL_MYSQL_DATABASE_SYSTEM'¶
A constant which can be used with the entity_source property of a DatabaseInsightSummary. This constant has a value of “EXTERNAL_MYSQL_DATABASE_SYSTEM”
- ENTITY_SOURCE_MACS_MANAGED_AUTONOMOUS_DATABASE = 'MACS_MANAGED_AUTONOMOUS_DATABASE'¶
A constant which can be used with the entity_source property of a DatabaseInsightSummary. This constant has a value of “MACS_MANAGED_AUTONOMOUS_DATABASE”
- ENTITY_SOURCE_MACS_MANAGED_CLOUD_DATABASE = 'MACS_MANAGED_CLOUD_DATABASE'¶
A constant which can be used with the entity_source property of a DatabaseInsightSummary. This constant has a value of “MACS_MANAGED_CLOUD_DATABASE”
- ENTITY_SOURCE_MACS_MANAGED_EXTERNAL_DATABASE = 'MACS_MANAGED_EXTERNAL_DATABASE'¶
A constant which can be used with the entity_source property of a DatabaseInsightSummary. This constant has a value of “MACS_MANAGED_EXTERNAL_DATABASE”
- ENTITY_SOURCE_MDS_MYSQL_DATABASE_SYSTEM = 'MDS_MYSQL_DATABASE_SYSTEM'¶
A constant which can be used with the entity_source property of a DatabaseInsightSummary. This constant has a value of “MDS_MYSQL_DATABASE_SYSTEM”
- ENTITY_SOURCE_PE_COMANAGED_DATABASE = 'PE_COMANAGED_DATABASE'¶
A constant which can be used with the entity_source property of a DatabaseInsightSummary. This constant has a value of “PE_COMANAGED_DATABASE”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a DatabaseInsightSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a DatabaseInsightSummary. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a DatabaseInsightSummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a DatabaseInsightSummary. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a DatabaseInsightSummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶
A constant which can be used with the lifecycle_state property of a DatabaseInsightSummary. This constant has a value of “NEEDS_ATTENTION”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a DatabaseInsightSummary. This constant has a value of “UPDATING”
- STATUS_DISABLED = 'DISABLED'¶
A constant which can be used with the status property of a DatabaseInsightSummary. This constant has a value of “DISABLED”
- STATUS_ENABLED = 'ENABLED'¶
A constant which can be used with the status property of a DatabaseInsightSummary. This constant has a value of “ENABLED”
- STATUS_TERMINATED = 'TERMINATED'¶
A constant which can be used with the status property of a DatabaseInsightSummary. This constant has a value of “TERMINATED”
- __init__(**kwargs)¶
Initializes a new DatabaseInsightSummary object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
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 DatabaseInsightSummary.
database_id (str) – The value to assign to the database_id property of this DatabaseInsightSummary.
compartment_id (str) – The value to assign to the compartment_id property of this DatabaseInsightSummary.
database_name (str) – The value to assign to the database_name property of this DatabaseInsightSummary.
database_display_name (str) – The value to assign to the database_display_name property of this DatabaseInsightSummary.
database_type (str) – The value to assign to the database_type property of this DatabaseInsightSummary.
database_version (str) – The value to assign to the database_version property of this DatabaseInsightSummary.
database_host_names (list[str]) – The value to assign to the database_host_names property of this DatabaseInsightSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabaseInsightSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabaseInsightSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatabaseInsightSummary.
entity_source (str) – The value to assign to the entity_source property of this DatabaseInsightSummary. Allowed values for this property are: “AUTONOMOUS_DATABASE”, “EM_MANAGED_EXTERNAL_DATABASE”, “MACS_MANAGED_EXTERNAL_DATABASE”, “PE_COMANAGED_DATABASE”, “MDS_MYSQL_DATABASE_SYSTEM”, “EXTERNAL_MYSQL_DATABASE_SYSTEM”, “MACS_MANAGED_CLOUD_DATABASE”, “MACS_MANAGED_AUTONOMOUS_DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
processor_count (int) – The value to assign to the processor_count property of this DatabaseInsightSummary.
status (str) – The value to assign to the status property of this DatabaseInsightSummary. Allowed values for this property are: “DISABLED”, “ENABLED”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this DatabaseInsightSummary.
time_updated (datetime) – The value to assign to the time_updated property of this DatabaseInsightSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseInsightSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DatabaseInsightSummary.
database_connection_status_details (str) – The value to assign to the database_connection_status_details property of this DatabaseInsightSummary.
- property compartment_id¶
Gets the compartment_id of this DatabaseInsightSummary. The OCID of the compartment.
- Returns
The compartment_id of this DatabaseInsightSummary.
- Return type
str
- property database_connection_status_details¶
Gets the database_connection_status_details of this DatabaseInsightSummary. A message describing the status of the database connection of this resource. For example, it can be used to provide actionable information about the permission and content validity of the database connection.
- Returns
The database_connection_status_details of this DatabaseInsightSummary.
- Return type
str
- property database_display_name¶
Gets the database_display_name of this DatabaseInsightSummary. The user-friendly name for the database. The name does not have to be unique.
- Returns
The database_display_name of this DatabaseInsightSummary.
- Return type
str
- property database_host_names¶
Gets the database_host_names of this DatabaseInsightSummary. The hostnames for the database.
- Returns
The database_host_names of this DatabaseInsightSummary.
- Return type
list[str]
- property database_id¶
[Required] Gets the database_id of this DatabaseInsightSummary. The OCID of the database.
- Returns
The database_id of this DatabaseInsightSummary.
- Return type
str
- property database_name¶
Gets the database_name of this DatabaseInsightSummary. The database name. The database name is unique within the tenancy.
- Returns
The database_name of this DatabaseInsightSummary.
- Return type
str
- property database_type¶
Gets the database_type of this DatabaseInsightSummary. Ops Insights internal representation of the database type.
- Returns
The database_type of this DatabaseInsightSummary.
- Return type
str
- property database_version¶
Gets the database_version of this DatabaseInsightSummary. The version of the database.
- Returns
The database_version of this DatabaseInsightSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this DatabaseInsightSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this DatabaseInsightSummary.
- Return type
dict(str, dict(str, object))
- property entity_source¶
[Required] Gets the entity_source of this DatabaseInsightSummary. Source of the database entity.
Allowed values for this property are: “AUTONOMOUS_DATABASE”, “EM_MANAGED_EXTERNAL_DATABASE”, “MACS_MANAGED_EXTERNAL_DATABASE”, “PE_COMANAGED_DATABASE”, “MDS_MYSQL_DATABASE_SYSTEM”, “EXTERNAL_MYSQL_DATABASE_SYSTEM”, “MACS_MANAGED_CLOUD_DATABASE”, “MACS_MANAGED_AUTONOMOUS_DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The entity_source of this DatabaseInsightSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this DatabaseInsightSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}
- Returns
The freeform_tags of this DatabaseInsightSummary.
- Return type
dict(str, 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 id¶
[Required] Gets the id of this DatabaseInsightSummary. The OCID of the database insight resource.
- Returns
The id of this DatabaseInsightSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this DatabaseInsightSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- Returns
The lifecycle_details of this DatabaseInsightSummary.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this DatabaseInsightSummary. The current state of the database.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this DatabaseInsightSummary.
- Return type
str
- property processor_count¶
Gets the processor_count of this DatabaseInsightSummary. Processor count. This is the OCPU count for Autonomous Database and CPU core count for other database types.
- Returns
The processor_count of this DatabaseInsightSummary.
- Return type
int
- property status¶
Gets the status of this DatabaseInsightSummary. Indicates the status of a database insight in Operations Insights
Allowed values for this property are: “DISABLED”, “ENABLED”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The status of this DatabaseInsightSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this DatabaseInsightSummary. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this DatabaseInsightSummary.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this DatabaseInsightSummary. The time the the database insight was first enabled. An RFC3339 formatted datetime string
- Returns
The time_created of this DatabaseInsightSummary.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this DatabaseInsightSummary. The time the database insight was updated. An RFC3339 formatted datetime string
- Returns
The time_updated of this DatabaseInsightSummary.
- Return type
datetime