File: //lib/mysqlsh/lib/python3.8/site-packages/oci/database_management/models/database_usage_metrics.py
# coding: utf-8
# Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101
from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401
from oci.decorators import init_model_state_from_kwargs
@init_model_state_from_kwargs
class DatabaseUsageMetrics(object):
"""
The list of aggregated metrics for Managed Databases in the fleet.
"""
#: A constant which can be used with the database_type property of a DatabaseUsageMetrics.
#: This constant has a value of "EXTERNAL_SIDB"
DATABASE_TYPE_EXTERNAL_SIDB = "EXTERNAL_SIDB"
#: A constant which can be used with the database_type property of a DatabaseUsageMetrics.
#: This constant has a value of "EXTERNAL_RAC"
DATABASE_TYPE_EXTERNAL_RAC = "EXTERNAL_RAC"
#: A constant which can be used with the database_type property of a DatabaseUsageMetrics.
#: This constant has a value of "CLOUD_SIDB"
DATABASE_TYPE_CLOUD_SIDB = "CLOUD_SIDB"
#: A constant which can be used with the database_type property of a DatabaseUsageMetrics.
#: This constant has a value of "CLOUD_RAC"
DATABASE_TYPE_CLOUD_RAC = "CLOUD_RAC"
#: A constant which can be used with the database_type property of a DatabaseUsageMetrics.
#: This constant has a value of "SHARED"
DATABASE_TYPE_SHARED = "SHARED"
#: A constant which can be used with the database_type property of a DatabaseUsageMetrics.
#: This constant has a value of "DEDICATED"
DATABASE_TYPE_DEDICATED = "DEDICATED"
#: A constant which can be used with the database_sub_type property of a DatabaseUsageMetrics.
#: This constant has a value of "CDB"
DATABASE_SUB_TYPE_CDB = "CDB"
#: A constant which can be used with the database_sub_type property of a DatabaseUsageMetrics.
#: This constant has a value of "PDB"
DATABASE_SUB_TYPE_PDB = "PDB"
#: A constant which can be used with the database_sub_type property of a DatabaseUsageMetrics.
#: This constant has a value of "NON_CDB"
DATABASE_SUB_TYPE_NON_CDB = "NON_CDB"
#: A constant which can be used with the database_sub_type property of a DatabaseUsageMetrics.
#: This constant has a value of "ACD"
DATABASE_SUB_TYPE_ACD = "ACD"
#: A constant which can be used with the database_sub_type property of a DatabaseUsageMetrics.
#: This constant has a value of "ADB"
DATABASE_SUB_TYPE_ADB = "ADB"
#: A constant which can be used with the deployment_type property of a DatabaseUsageMetrics.
#: This constant has a value of "ONPREMISE"
DEPLOYMENT_TYPE_ONPREMISE = "ONPREMISE"
#: A constant which can be used with the deployment_type property of a DatabaseUsageMetrics.
#: This constant has a value of "BM"
DEPLOYMENT_TYPE_BM = "BM"
#: A constant which can be used with the deployment_type property of a DatabaseUsageMetrics.
#: This constant has a value of "VM"
DEPLOYMENT_TYPE_VM = "VM"
#: A constant which can be used with the deployment_type property of a DatabaseUsageMetrics.
#: This constant has a value of "EXADATA"
DEPLOYMENT_TYPE_EXADATA = "EXADATA"
#: A constant which can be used with the deployment_type property of a DatabaseUsageMetrics.
#: This constant has a value of "EXADATA_CC"
DEPLOYMENT_TYPE_EXADATA_CC = "EXADATA_CC"
#: A constant which can be used with the deployment_type property of a DatabaseUsageMetrics.
#: This constant has a value of "AUTONOMOUS"
DEPLOYMENT_TYPE_AUTONOMOUS = "AUTONOMOUS"
#: A constant which can be used with the deployment_type property of a DatabaseUsageMetrics.
#: This constant has a value of "EXADATA_XS"
DEPLOYMENT_TYPE_EXADATA_XS = "EXADATA_XS"
#: A constant which can be used with the workload_type property of a DatabaseUsageMetrics.
#: This constant has a value of "OLTP"
WORKLOAD_TYPE_OLTP = "OLTP"
#: A constant which can be used with the workload_type property of a DatabaseUsageMetrics.
#: This constant has a value of "DW"
WORKLOAD_TYPE_DW = "DW"
#: A constant which can be used with the workload_type property of a DatabaseUsageMetrics.
#: This constant has a value of "AJD"
WORKLOAD_TYPE_AJD = "AJD"
#: A constant which can be used with the workload_type property of a DatabaseUsageMetrics.
#: This constant has a value of "APEX"
WORKLOAD_TYPE_APEX = "APEX"
#: A constant which can be used with the db_role property of a DatabaseUsageMetrics.
#: This constant has a value of "SNAPSHOT_STANDBY"
DB_ROLE_SNAPSHOT_STANDBY = "SNAPSHOT_STANDBY"
#: A constant which can be used with the db_role property of a DatabaseUsageMetrics.
#: This constant has a value of "LOGICAL_STANDBY"
DB_ROLE_LOGICAL_STANDBY = "LOGICAL_STANDBY"
#: A constant which can be used with the db_role property of a DatabaseUsageMetrics.
#: This constant has a value of "PHYSICAL_STANDBY"
DB_ROLE_PHYSICAL_STANDBY = "PHYSICAL_STANDBY"
#: A constant which can be used with the db_role property of a DatabaseUsageMetrics.
#: This constant has a value of "PRIMARY"
DB_ROLE_PRIMARY = "PRIMARY"
#: A constant which can be used with the db_role property of a DatabaseUsageMetrics.
#: This constant has a value of "FAR_SYNC"
DB_ROLE_FAR_SYNC = "FAR_SYNC"
def __init__(self, **kwargs):
"""
Initializes a new DatabaseUsageMetrics object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param db_id:
The value to assign to the db_id property of this DatabaseUsageMetrics.
:type db_id: str
:param compartment_id:
The value to assign to the compartment_id property of this DatabaseUsageMetrics.
:type compartment_id: str
:param database_type:
The value to assign to the database_type property of this DatabaseUsageMetrics.
Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type database_type: str
:param database_sub_type:
The value to assign to the database_sub_type property of this DatabaseUsageMetrics.
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'.
:type database_sub_type: str
:param deployment_type:
The value to assign to the deployment_type property of this DatabaseUsageMetrics.
Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", "EXADATA_XS", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type deployment_type: str
:param database_version:
The value to assign to the database_version property of this DatabaseUsageMetrics.
:type database_version: str
:param workload_type:
The value to assign to the workload_type property of this DatabaseUsageMetrics.
Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type workload_type: str
:param database_name:
The value to assign to the database_name property of this DatabaseUsageMetrics.
:type database_name: str
:param database_container_id:
The value to assign to the database_container_id property of this DatabaseUsageMetrics.
:type database_container_id: str
:param database_id:
The value to assign to the database_id property of this DatabaseUsageMetrics.
:type database_id: str
:param primary_db_id:
The value to assign to the primary_db_id property of this DatabaseUsageMetrics.
:type primary_db_id: str
:param primary_db_unique_name:
The value to assign to the primary_db_unique_name property of this DatabaseUsageMetrics.
:type primary_db_unique_name: str
:param db_unique_name:
The value to assign to the db_unique_name property of this DatabaseUsageMetrics.
:type db_unique_name: str
:param db_role:
The value to assign to the db_role property of this DatabaseUsageMetrics.
Allowed values for this property are: "SNAPSHOT_STANDBY", "LOGICAL_STANDBY", "PHYSICAL_STANDBY", "PRIMARY", "FAR_SYNC", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type db_role: str
:param metrics:
The value to assign to the metrics property of this DatabaseUsageMetrics.
:type metrics: list[oci.database_management.models.FleetMetricDefinition]
"""
self.swagger_types = {
'db_id': 'str',
'compartment_id': 'str',
'database_type': 'str',
'database_sub_type': 'str',
'deployment_type': 'str',
'database_version': 'str',
'workload_type': 'str',
'database_name': 'str',
'database_container_id': 'str',
'database_id': 'str',
'primary_db_id': 'str',
'primary_db_unique_name': 'str',
'db_unique_name': 'str',
'db_role': 'str',
'metrics': 'list[FleetMetricDefinition]'
}
self.attribute_map = {
'db_id': 'dbId',
'compartment_id': 'compartmentId',
'database_type': 'databaseType',
'database_sub_type': 'databaseSubType',
'deployment_type': 'deploymentType',
'database_version': 'databaseVersion',
'workload_type': 'workloadType',
'database_name': 'databaseName',
'database_container_id': 'databaseContainerId',
'database_id': 'databaseId',
'primary_db_id': 'primaryDbId',
'primary_db_unique_name': 'primaryDbUniqueName',
'db_unique_name': 'dbUniqueName',
'db_role': 'dbRole',
'metrics': 'metrics'
}
self._db_id = None
self._compartment_id = None
self._database_type = None
self._database_sub_type = None
self._deployment_type = None
self._database_version = None
self._workload_type = None
self._database_name = None
self._database_container_id = None
self._database_id = None
self._primary_db_id = None
self._primary_db_unique_name = None
self._db_unique_name = None
self._db_role = None
self._metrics = None
@property
def db_id(self):
"""
Gets the db_id of this DatabaseUsageMetrics.
The `OCID`__ of the Managed Database.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The db_id of this DatabaseUsageMetrics.
:rtype: str
"""
return self._db_id
@db_id.setter
def db_id(self, db_id):
"""
Sets the db_id of this DatabaseUsageMetrics.
The `OCID`__ of the Managed Database.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param db_id: The db_id of this DatabaseUsageMetrics.
:type: str
"""
self._db_id = db_id
@property
def compartment_id(self):
"""
Gets the compartment_id of this DatabaseUsageMetrics.
The `OCID`__ of the compartment where the Managed Database resides.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The compartment_id of this DatabaseUsageMetrics.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this DatabaseUsageMetrics.
The `OCID`__ of the compartment where the Managed Database resides.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param compartment_id: The compartment_id of this DatabaseUsageMetrics.
:type: str
"""
self._compartment_id = compartment_id
@property
def database_type(self):
"""
Gets the database_type of this DatabaseUsageMetrics.
The type of Oracle Database installation.
Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The database_type of this DatabaseUsageMetrics.
:rtype: str
"""
return self._database_type
@database_type.setter
def database_type(self, database_type):
"""
Sets the database_type of this DatabaseUsageMetrics.
The type of Oracle Database installation.
:param database_type: The database_type of this DatabaseUsageMetrics.
:type: str
"""
allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED"]
if not value_allowed_none_or_none_sentinel(database_type, allowed_values):
database_type = 'UNKNOWN_ENUM_VALUE'
self._database_type = database_type
@property
def database_sub_type(self):
"""
Gets the database_sub_type of this DatabaseUsageMetrics.
The subtype of the Oracle Database. Indicates whether the database is a Container Database,
Pluggable Database, Non-container Database, Autonomous Database, or Autonomous 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'.
:return: The database_sub_type of this DatabaseUsageMetrics.
:rtype: str
"""
return self._database_sub_type
@database_sub_type.setter
def database_sub_type(self, database_sub_type):
"""
Sets the database_sub_type of this DatabaseUsageMetrics.
The subtype of the Oracle Database. Indicates whether the database is a Container Database,
Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
:param database_sub_type: The database_sub_type of this DatabaseUsageMetrics.
:type: str
"""
allowed_values = ["CDB", "PDB", "NON_CDB", "ACD", "ADB"]
if not value_allowed_none_or_none_sentinel(database_sub_type, allowed_values):
database_sub_type = 'UNKNOWN_ENUM_VALUE'
self._database_sub_type = database_sub_type
@property
def deployment_type(self):
"""
Gets the deployment_type of this DatabaseUsageMetrics.
The infrastructure used to deploy the Oracle Database.
Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", "EXADATA_XS", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The deployment_type of this DatabaseUsageMetrics.
:rtype: str
"""
return self._deployment_type
@deployment_type.setter
def deployment_type(self, deployment_type):
"""
Sets the deployment_type of this DatabaseUsageMetrics.
The infrastructure used to deploy the Oracle Database.
:param deployment_type: The deployment_type of this DatabaseUsageMetrics.
:type: str
"""
allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", "EXADATA_XS"]
if not value_allowed_none_or_none_sentinel(deployment_type, allowed_values):
deployment_type = 'UNKNOWN_ENUM_VALUE'
self._deployment_type = deployment_type
@property
def database_version(self):
"""
Gets the database_version of this DatabaseUsageMetrics.
The Oracle Database version.
:return: The database_version of this DatabaseUsageMetrics.
:rtype: str
"""
return self._database_version
@database_version.setter
def database_version(self, database_version):
"""
Sets the database_version of this DatabaseUsageMetrics.
The Oracle Database version.
:param database_version: The database_version of this DatabaseUsageMetrics.
:type: str
"""
self._database_version = database_version
@property
def workload_type(self):
"""
Gets the workload_type of this DatabaseUsageMetrics.
The workload type of the Autonomous Database.
Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The workload_type of this DatabaseUsageMetrics.
:rtype: str
"""
return self._workload_type
@workload_type.setter
def workload_type(self, workload_type):
"""
Sets the workload_type of this DatabaseUsageMetrics.
The workload type of the Autonomous Database.
:param workload_type: The workload_type of this DatabaseUsageMetrics.
:type: str
"""
allowed_values = ["OLTP", "DW", "AJD", "APEX"]
if not value_allowed_none_or_none_sentinel(workload_type, allowed_values):
workload_type = 'UNKNOWN_ENUM_VALUE'
self._workload_type = workload_type
@property
def database_name(self):
"""
Gets the database_name of this DatabaseUsageMetrics.
The display name of the Managed Database.
:return: The database_name of this DatabaseUsageMetrics.
:rtype: str
"""
return self._database_name
@database_name.setter
def database_name(self, database_name):
"""
Sets the database_name of this DatabaseUsageMetrics.
The display name of the Managed Database.
:param database_name: The database_name of this DatabaseUsageMetrics.
:type: str
"""
self._database_name = database_name
@property
def database_container_id(self):
"""
Gets the database_container_id of this DatabaseUsageMetrics.
The `OCID`__ of the parent Container Database, in the case of a Pluggable Database.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The database_container_id of this DatabaseUsageMetrics.
:rtype: str
"""
return self._database_container_id
@database_container_id.setter
def database_container_id(self, database_container_id):
"""
Sets the database_container_id of this DatabaseUsageMetrics.
The `OCID`__ of the parent Container Database, in the case of a Pluggable Database.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param database_container_id: The database_container_id of this DatabaseUsageMetrics.
:type: str
"""
self._database_container_id = database_container_id
@property
def database_id(self):
"""
Gets the database_id of this DatabaseUsageMetrics.
The Database id of the Managed Database. Every database had its own id and that value is captured here.
:return: The database_id of this DatabaseUsageMetrics.
:rtype: str
"""
return self._database_id
@database_id.setter
def database_id(self, database_id):
"""
Sets the database_id of this DatabaseUsageMetrics.
The Database id of the Managed Database. Every database had its own id and that value is captured here.
:param database_id: The database_id of this DatabaseUsageMetrics.
:type: str
"""
self._database_id = database_id
@property
def primary_db_id(self):
"""
Gets the primary_db_id of this DatabaseUsageMetrics.
The Primary Database id of the Managed Database.
:return: The primary_db_id of this DatabaseUsageMetrics.
:rtype: str
"""
return self._primary_db_id
@primary_db_id.setter
def primary_db_id(self, primary_db_id):
"""
Sets the primary_db_id of this DatabaseUsageMetrics.
The Primary Database id of the Managed Database.
:param primary_db_id: The primary_db_id of this DatabaseUsageMetrics.
:type: str
"""
self._primary_db_id = primary_db_id
@property
def primary_db_unique_name(self):
"""
Gets the primary_db_unique_name of this DatabaseUsageMetrics.
The Primary Database unique name of the Managed Database.
:return: The primary_db_unique_name of this DatabaseUsageMetrics.
:rtype: str
"""
return self._primary_db_unique_name
@primary_db_unique_name.setter
def primary_db_unique_name(self, primary_db_unique_name):
"""
Sets the primary_db_unique_name of this DatabaseUsageMetrics.
The Primary Database unique name of the Managed Database.
:param primary_db_unique_name: The primary_db_unique_name of this DatabaseUsageMetrics.
:type: str
"""
self._primary_db_unique_name = primary_db_unique_name
@property
def db_unique_name(self):
"""
Gets the db_unique_name of this DatabaseUsageMetrics.
The Database unique name of the Managed Database.
:return: The db_unique_name of this DatabaseUsageMetrics.
:rtype: str
"""
return self._db_unique_name
@db_unique_name.setter
def db_unique_name(self, db_unique_name):
"""
Sets the db_unique_name of this DatabaseUsageMetrics.
The Database unique name of the Managed Database.
:param db_unique_name: The db_unique_name of this DatabaseUsageMetrics.
:type: str
"""
self._db_unique_name = db_unique_name
@property
def db_role(self):
"""
Gets the db_role of this DatabaseUsageMetrics.
The Database role of the Managed Database.
Allowed values for this property are: "SNAPSHOT_STANDBY", "LOGICAL_STANDBY", "PHYSICAL_STANDBY", "PRIMARY", "FAR_SYNC", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The db_role of this DatabaseUsageMetrics.
:rtype: str
"""
return self._db_role
@db_role.setter
def db_role(self, db_role):
"""
Sets the db_role of this DatabaseUsageMetrics.
The Database role of the Managed Database.
:param db_role: The db_role of this DatabaseUsageMetrics.
:type: str
"""
allowed_values = ["SNAPSHOT_STANDBY", "LOGICAL_STANDBY", "PHYSICAL_STANDBY", "PRIMARY", "FAR_SYNC"]
if not value_allowed_none_or_none_sentinel(db_role, allowed_values):
db_role = 'UNKNOWN_ENUM_VALUE'
self._db_role = db_role
@property
def metrics(self):
"""
Gets the metrics of this DatabaseUsageMetrics.
A list of the database health metrics like CPU, Storage, and Memory.
:return: The metrics of this DatabaseUsageMetrics.
:rtype: list[oci.database_management.models.FleetMetricDefinition]
"""
return self._metrics
@metrics.setter
def metrics(self, metrics):
"""
Sets the metrics of this DatabaseUsageMetrics.
A list of the database health metrics like CPU, Storage, and Memory.
:param metrics: The metrics of this DatabaseUsageMetrics.
:type: list[oci.database_management.models.FleetMetricDefinition]
"""
self._metrics = metrics
def __repr__(self):
return formatted_flat_dict(self)
def __eq__(self, other):
if other is None:
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
return not self == other