File: //lib/mysqlsh/lib/python3.8/site-packages/oci/opsi/models/host_performance_metric_group.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: 20200630
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 HostPerformanceMetricGroup(object):
"""
Base Metric Group for Host performance metrics
"""
#: A constant which can be used with the metric_name property of a HostPerformanceMetricGroup.
#: This constant has a value of "HOST_CPU_USAGE"
METRIC_NAME_HOST_CPU_USAGE = "HOST_CPU_USAGE"
#: A constant which can be used with the metric_name property of a HostPerformanceMetricGroup.
#: This constant has a value of "HOST_MEMORY_USAGE"
METRIC_NAME_HOST_MEMORY_USAGE = "HOST_MEMORY_USAGE"
#: A constant which can be used with the metric_name property of a HostPerformanceMetricGroup.
#: This constant has a value of "HOST_NETWORK_ACTIVITY_SUMMARY"
METRIC_NAME_HOST_NETWORK_ACTIVITY_SUMMARY = "HOST_NETWORK_ACTIVITY_SUMMARY"
#: A constant which can be used with the metric_name property of a HostPerformanceMetricGroup.
#: This constant has a value of "HOST_TOP_PROCESSES"
METRIC_NAME_HOST_TOP_PROCESSES = "HOST_TOP_PROCESSES"
#: A constant which can be used with the metric_name property of a HostPerformanceMetricGroup.
#: This constant has a value of "HOST_FILESYSTEM_USAGE"
METRIC_NAME_HOST_FILESYSTEM_USAGE = "HOST_FILESYSTEM_USAGE"
#: A constant which can be used with the metric_name property of a HostPerformanceMetricGroup.
#: This constant has a value of "HOST_GPU_USAGE"
METRIC_NAME_HOST_GPU_USAGE = "HOST_GPU_USAGE"
#: A constant which can be used with the metric_name property of a HostPerformanceMetricGroup.
#: This constant has a value of "HOST_GPU_PROCESSES"
METRIC_NAME_HOST_GPU_PROCESSES = "HOST_GPU_PROCESSES"
#: A constant which can be used with the metric_name property of a HostPerformanceMetricGroup.
#: This constant has a value of "HOST_IO_USAGE"
METRIC_NAME_HOST_IO_USAGE = "HOST_IO_USAGE"
def __init__(self, **kwargs):
"""
Initializes a new HostPerformanceMetricGroup 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:
* :class:`~oci.opsi.models.HostMemoryUsage`
* :class:`~oci.opsi.models.HostTopProcesses`
* :class:`~oci.opsi.models.HostCpuUsage`
* :class:`~oci.opsi.models.HostGpuUsage`
* :class:`~oci.opsi.models.HostGpuProcesses`
* :class:`~oci.opsi.models.HostFilesystemUsage`
* :class:`~oci.opsi.models.HostIoUsage`
* :class:`~oci.opsi.models.HostNetworkActivitySummary`
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param metric_name:
The value to assign to the metric_name property of this HostPerformanceMetricGroup.
Allowed values for this property are: "HOST_CPU_USAGE", "HOST_MEMORY_USAGE", "HOST_NETWORK_ACTIVITY_SUMMARY", "HOST_TOP_PROCESSES", "HOST_FILESYSTEM_USAGE", "HOST_GPU_USAGE", "HOST_GPU_PROCESSES", "HOST_IO_USAGE"
:type metric_name: str
:param time_collected:
The value to assign to the time_collected property of this HostPerformanceMetricGroup.
:type time_collected: datetime
"""
self.swagger_types = {
'metric_name': 'str',
'time_collected': 'datetime'
}
self.attribute_map = {
'metric_name': 'metricName',
'time_collected': 'timeCollected'
}
self._metric_name = None
self._time_collected = None
@staticmethod
def 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.
"""
type = object_dictionary['metricName']
if type == 'HOST_MEMORY_USAGE':
return 'HostMemoryUsage'
if type == 'HOST_TOP_PROCESSES':
return 'HostTopProcesses'
if type == 'HOST_CPU_USAGE':
return 'HostCpuUsage'
if type == 'HOST_GPU_USAGE':
return 'HostGpuUsage'
if type == 'HOST_GPU_PROCESSES':
return 'HostGpuProcesses'
if type == 'HOST_FILESYSTEM_USAGE':
return 'HostFilesystemUsage'
if type == 'HOST_IO_USAGE':
return 'HostIoUsage'
if type == 'HOST_NETWORK_ACTIVITY_SUMMARY':
return 'HostNetworkActivitySummary'
else:
return 'HostPerformanceMetricGroup'
@property
def metric_name(self):
"""
**[Required]** Gets the metric_name of this HostPerformanceMetricGroup.
Name of the metric group
Allowed values for this property are: "HOST_CPU_USAGE", "HOST_MEMORY_USAGE", "HOST_NETWORK_ACTIVITY_SUMMARY", "HOST_TOP_PROCESSES", "HOST_FILESYSTEM_USAGE", "HOST_GPU_USAGE", "HOST_GPU_PROCESSES", "HOST_IO_USAGE"
:return: The metric_name of this HostPerformanceMetricGroup.
:rtype: str
"""
return self._metric_name
@metric_name.setter
def metric_name(self, metric_name):
"""
Sets the metric_name of this HostPerformanceMetricGroup.
Name of the metric group
:param metric_name: The metric_name of this HostPerformanceMetricGroup.
:type: str
"""
allowed_values = ["HOST_CPU_USAGE", "HOST_MEMORY_USAGE", "HOST_NETWORK_ACTIVITY_SUMMARY", "HOST_TOP_PROCESSES", "HOST_FILESYSTEM_USAGE", "HOST_GPU_USAGE", "HOST_GPU_PROCESSES", "HOST_IO_USAGE"]
if not value_allowed_none_or_none_sentinel(metric_name, allowed_values):
raise ValueError(
f"Invalid value for `metric_name`, must be None or one of {allowed_values}"
)
self._metric_name = metric_name
@property
def time_collected(self):
"""
**[Required]** Gets the time_collected of this HostPerformanceMetricGroup.
Collection timestamp
Example: `\"2020-05-06T00:00:00.000Z\"`
:return: The time_collected of this HostPerformanceMetricGroup.
:rtype: datetime
"""
return self._time_collected
@time_collected.setter
def time_collected(self, time_collected):
"""
Sets the time_collected of this HostPerformanceMetricGroup.
Collection timestamp
Example: `\"2020-05-06T00:00:00.000Z\"`
:param time_collected: The time_collected of this HostPerformanceMetricGroup.
:type: datetime
"""
self._time_collected = time_collected
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