File: //lib/mysqlsh/lib/python3.8/site-packages/oci/database_management/models/awr_db_summary.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 AwrDbSummary(object):
"""
The AWR summary for a database.
"""
def __init__(self, **kwargs):
"""
Initializes a new AwrDbSummary object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param awr_db_id:
The value to assign to the awr_db_id property of this AwrDbSummary.
:type awr_db_id: str
:param db_name:
The value to assign to the db_name property of this AwrDbSummary.
:type db_name: str
:param db_unique_name:
The value to assign to the db_unique_name property of this AwrDbSummary.
:type db_unique_name: str
:param src_db_id:
The value to assign to the src_db_id property of this AwrDbSummary.
:type src_db_id: str
:param src_db_name:
The value to assign to the src_db_name property of this AwrDbSummary.
:type src_db_name: str
:param instance_list:
The value to assign to the instance_list property of this AwrDbSummary.
:type instance_list: list[int]
:param time_db_startup:
The value to assign to the time_db_startup property of this AwrDbSummary.
:type time_db_startup: datetime
:param time_first_snapshot_begin:
The value to assign to the time_first_snapshot_begin property of this AwrDbSummary.
:type time_first_snapshot_begin: datetime
:param time_latest_snapshot_end:
The value to assign to the time_latest_snapshot_end property of this AwrDbSummary.
:type time_latest_snapshot_end: datetime
:param first_snapshot_id:
The value to assign to the first_snapshot_id property of this AwrDbSummary.
:type first_snapshot_id: int
:param latest_snapshot_id:
The value to assign to the latest_snapshot_id property of this AwrDbSummary.
:type latest_snapshot_id: int
:param snapshot_count:
The value to assign to the snapshot_count property of this AwrDbSummary.
:type snapshot_count: int
:param snapshot_interval_in_min:
The value to assign to the snapshot_interval_in_min property of this AwrDbSummary.
:type snapshot_interval_in_min: int
:param container_id:
The value to assign to the container_id property of this AwrDbSummary.
:type container_id: int
:param db_version:
The value to assign to the db_version property of this AwrDbSummary.
:type db_version: str
:param snapshot_timezone:
The value to assign to the snapshot_timezone property of this AwrDbSummary.
:type snapshot_timezone: str
"""
self.swagger_types = {
'awr_db_id': 'str',
'db_name': 'str',
'db_unique_name': 'str',
'src_db_id': 'str',
'src_db_name': 'str',
'instance_list': 'list[int]',
'time_db_startup': 'datetime',
'time_first_snapshot_begin': 'datetime',
'time_latest_snapshot_end': 'datetime',
'first_snapshot_id': 'int',
'latest_snapshot_id': 'int',
'snapshot_count': 'int',
'snapshot_interval_in_min': 'int',
'container_id': 'int',
'db_version': 'str',
'snapshot_timezone': 'str'
}
self.attribute_map = {
'awr_db_id': 'awrDbId',
'db_name': 'dbName',
'db_unique_name': 'dbUniqueName',
'src_db_id': 'srcDbId',
'src_db_name': 'srcDbName',
'instance_list': 'instanceList',
'time_db_startup': 'timeDbStartup',
'time_first_snapshot_begin': 'timeFirstSnapshotBegin',
'time_latest_snapshot_end': 'timeLatestSnapshotEnd',
'first_snapshot_id': 'firstSnapshotId',
'latest_snapshot_id': 'latestSnapshotId',
'snapshot_count': 'snapshotCount',
'snapshot_interval_in_min': 'snapshotIntervalInMin',
'container_id': 'containerId',
'db_version': 'dbVersion',
'snapshot_timezone': 'snapshotTimezone'
}
self._awr_db_id = None
self._db_name = None
self._db_unique_name = None
self._src_db_id = None
self._src_db_name = None
self._instance_list = None
self._time_db_startup = None
self._time_first_snapshot_begin = None
self._time_latest_snapshot_end = None
self._first_snapshot_id = None
self._latest_snapshot_id = None
self._snapshot_count = None
self._snapshot_interval_in_min = None
self._container_id = None
self._db_version = None
self._snapshot_timezone = None
@property
def awr_db_id(self):
"""
**[Required]** Gets the awr_db_id of this AwrDbSummary.
The internal ID of the database. The internal ID of the database is not the `OCID`__.
It can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbs
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The awr_db_id of this AwrDbSummary.
:rtype: str
"""
return self._awr_db_id
@awr_db_id.setter
def awr_db_id(self, awr_db_id):
"""
Sets the awr_db_id of this AwrDbSummary.
The internal ID of the database. The internal ID of the database is not the `OCID`__.
It can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbs
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param awr_db_id: The awr_db_id of this AwrDbSummary.
:type: str
"""
self._awr_db_id = awr_db_id
@property
def db_name(self):
"""
**[Required]** Gets the db_name of this AwrDbSummary.
The name of the database.
:return: The db_name of this AwrDbSummary.
:rtype: str
"""
return self._db_name
@db_name.setter
def db_name(self, db_name):
"""
Sets the db_name of this AwrDbSummary.
The name of the database.
:param db_name: The db_name of this AwrDbSummary.
:type: str
"""
self._db_name = db_name
@property
def db_unique_name(self):
"""
Gets the db_unique_name of this AwrDbSummary.
The unique name of the database.
:return: The db_unique_name of this AwrDbSummary.
: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 AwrDbSummary.
The unique name of the database.
:param db_unique_name: The db_unique_name of this AwrDbSummary.
:type: str
"""
self._db_unique_name = db_unique_name
@property
def src_db_id(self):
"""
Gets the src_db_id of this AwrDbSummary.
The internal ID of the database where the AWR snapshot data was collected.
:return: The src_db_id of this AwrDbSummary.
:rtype: str
"""
return self._src_db_id
@src_db_id.setter
def src_db_id(self, src_db_id):
"""
Sets the src_db_id of this AwrDbSummary.
The internal ID of the database where the AWR snapshot data was collected.
:param src_db_id: The src_db_id of this AwrDbSummary.
:type: str
"""
self._src_db_id = src_db_id
@property
def src_db_name(self):
"""
Gets the src_db_name of this AwrDbSummary.
The name of the database where the AWR snapshot data was collected.
:return: The src_db_name of this AwrDbSummary.
:rtype: str
"""
return self._src_db_name
@src_db_name.setter
def src_db_name(self, src_db_name):
"""
Sets the src_db_name of this AwrDbSummary.
The name of the database where the AWR snapshot data was collected.
:param src_db_name: The src_db_name of this AwrDbSummary.
:type: str
"""
self._src_db_name = src_db_name
@property
def instance_list(self):
"""
Gets the instance_list of this AwrDbSummary.
The database instance numbers.
:return: The instance_list of this AwrDbSummary.
:rtype: list[int]
"""
return self._instance_list
@instance_list.setter
def instance_list(self, instance_list):
"""
Sets the instance_list of this AwrDbSummary.
The database instance numbers.
:param instance_list: The instance_list of this AwrDbSummary.
:type: list[int]
"""
self._instance_list = instance_list
@property
def time_db_startup(self):
"""
Gets the time_db_startup of this AwrDbSummary.
The timestamp of the database startup.
:return: The time_db_startup of this AwrDbSummary.
:rtype: datetime
"""
return self._time_db_startup
@time_db_startup.setter
def time_db_startup(self, time_db_startup):
"""
Sets the time_db_startup of this AwrDbSummary.
The timestamp of the database startup.
:param time_db_startup: The time_db_startup of this AwrDbSummary.
:type: datetime
"""
self._time_db_startup = time_db_startup
@property
def time_first_snapshot_begin(self):
"""
Gets the time_first_snapshot_begin of this AwrDbSummary.
The start time of the earliest snapshot.
:return: The time_first_snapshot_begin of this AwrDbSummary.
:rtype: datetime
"""
return self._time_first_snapshot_begin
@time_first_snapshot_begin.setter
def time_first_snapshot_begin(self, time_first_snapshot_begin):
"""
Sets the time_first_snapshot_begin of this AwrDbSummary.
The start time of the earliest snapshot.
:param time_first_snapshot_begin: The time_first_snapshot_begin of this AwrDbSummary.
:type: datetime
"""
self._time_first_snapshot_begin = time_first_snapshot_begin
@property
def time_latest_snapshot_end(self):
"""
Gets the time_latest_snapshot_end of this AwrDbSummary.
The end time of the latest snapshot.
:return: The time_latest_snapshot_end of this AwrDbSummary.
:rtype: datetime
"""
return self._time_latest_snapshot_end
@time_latest_snapshot_end.setter
def time_latest_snapshot_end(self, time_latest_snapshot_end):
"""
Sets the time_latest_snapshot_end of this AwrDbSummary.
The end time of the latest snapshot.
:param time_latest_snapshot_end: The time_latest_snapshot_end of this AwrDbSummary.
:type: datetime
"""
self._time_latest_snapshot_end = time_latest_snapshot_end
@property
def first_snapshot_id(self):
"""
Gets the first_snapshot_id of this AwrDbSummary.
The ID of the earliest snapshot. The snapshot ID is not the `OCID`__.
It can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSnapshots
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The first_snapshot_id of this AwrDbSummary.
:rtype: int
"""
return self._first_snapshot_id
@first_snapshot_id.setter
def first_snapshot_id(self, first_snapshot_id):
"""
Sets the first_snapshot_id of this AwrDbSummary.
The ID of the earliest snapshot. The snapshot ID is not the `OCID`__.
It can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSnapshots
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param first_snapshot_id: The first_snapshot_id of this AwrDbSummary.
:type: int
"""
self._first_snapshot_id = first_snapshot_id
@property
def latest_snapshot_id(self):
"""
Gets the latest_snapshot_id of this AwrDbSummary.
The ID of the latest snapshot. The snapshot ID is not the `OCID`__.
It can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSnapshots
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The latest_snapshot_id of this AwrDbSummary.
:rtype: int
"""
return self._latest_snapshot_id
@latest_snapshot_id.setter
def latest_snapshot_id(self, latest_snapshot_id):
"""
Sets the latest_snapshot_id of this AwrDbSummary.
The ID of the latest snapshot. The snapshot ID is not the `OCID`__.
It can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSnapshots
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param latest_snapshot_id: The latest_snapshot_id of this AwrDbSummary.
:type: int
"""
self._latest_snapshot_id = latest_snapshot_id
@property
def snapshot_count(self):
"""
Gets the snapshot_count of this AwrDbSummary.
The total number of snapshots.
:return: The snapshot_count of this AwrDbSummary.
:rtype: int
"""
return self._snapshot_count
@snapshot_count.setter
def snapshot_count(self, snapshot_count):
"""
Sets the snapshot_count of this AwrDbSummary.
The total number of snapshots.
:param snapshot_count: The snapshot_count of this AwrDbSummary.
:type: int
"""
self._snapshot_count = snapshot_count
@property
def snapshot_interval_in_min(self):
"""
Gets the snapshot_interval_in_min of this AwrDbSummary.
The interval time between snapshots (in minutes).
:return: The snapshot_interval_in_min of this AwrDbSummary.
:rtype: int
"""
return self._snapshot_interval_in_min
@snapshot_interval_in_min.setter
def snapshot_interval_in_min(self, snapshot_interval_in_min):
"""
Sets the snapshot_interval_in_min of this AwrDbSummary.
The interval time between snapshots (in minutes).
:param snapshot_interval_in_min: The snapshot_interval_in_min of this AwrDbSummary.
:type: int
"""
self._snapshot_interval_in_min = snapshot_interval_in_min
@property
def container_id(self):
"""
Gets the container_id of this AwrDbSummary.
ID of the database container. The database container ID is not the `OCID`__.
It can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The container_id of this AwrDbSummary.
:rtype: int
"""
return self._container_id
@container_id.setter
def container_id(self, container_id):
"""
Sets the container_id of this AwrDbSummary.
ID of the database container. The database container ID is not the `OCID`__.
It can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param container_id: The container_id of this AwrDbSummary.
:type: int
"""
self._container_id = container_id
@property
def db_version(self):
"""
Gets the db_version of this AwrDbSummary.
The version of the database.
:return: The db_version of this AwrDbSummary.
:rtype: str
"""
return self._db_version
@db_version.setter
def db_version(self, db_version):
"""
Sets the db_version of this AwrDbSummary.
The version of the database.
:param db_version: The db_version of this AwrDbSummary.
:type: str
"""
self._db_version = db_version
@property
def snapshot_timezone(self):
"""
Gets the snapshot_timezone of this AwrDbSummary.
The time zone of the snapshot.
:return: The snapshot_timezone of this AwrDbSummary.
:rtype: str
"""
return self._snapshot_timezone
@snapshot_timezone.setter
def snapshot_timezone(self, snapshot_timezone):
"""
Sets the snapshot_timezone of this AwrDbSummary.
The time zone of the snapshot.
:param snapshot_timezone: The snapshot_timezone of this AwrDbSummary.
:type: str
"""
self._snapshot_timezone = snapshot_timezone
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