rest_api.swagger_server.models.metric
index
/var/lib/jenkins/workspace/resmon_monitor_doc/rest_api/swagger_server/models/metric.py

# coding: utf-8

 
Modules
       
rest_api.swagger_server.util

 
Classes
       
rest_api.swagger_server.models.base_model_.Model(builtins.object)
Metric

 
class Metric(rest_api.swagger_server.models.base_model_.Model)
    NOTE: This class is auto generated by the swagger code generator program.
 
Do not edit the class manually.
 
 
Method resolution order:
Metric
rest_api.swagger_server.models.base_model_.Model
builtins.object

Methods defined here:
__init__(self, id:str=None, description:str=None, parent_id:str=None, unit:str=None, moving_window_duration:int=None, interval:int=None, removable:bool=None, hosts:List[str]=None)
Metric - a model defined in Swagger
 
:param id: The id of this Metric.  # noqa: E501
:type id: str
:param description: The description of this Metric.  # noqa: E501
:type description: str
:param parent_id: The parent_id of this Metric.  # noqa: E501
:type parent_id: str
:param unit: The unit of this Metric.  # noqa: E501
:type unit: str
:param moving_window_duration: The moving_window_duration of this Metric.  # noqa: E501
:type moving_window_duration: int
:param interval: The interval of this Metric.  # noqa: E501
:type interval: int
:param removable: The removable of this Metric.  # noqa: E501
:type removable: bool
:param hosts: The hosts of this Metric.  # noqa: E501
:type hosts: List[str]

Class methods defined here:
from_dict(dikt) -> 'Metric' from builtins.type
Returns the dict as a model
 
:param dikt: A dict.
:type: dict
:return: The Metric of this Metric.  # noqa: E501
:rtype: Metric

Data descriptors defined here:
description
Gets the description of this Metric.
 
Detailed informations about metric  # noqa: E501
 
:return: The description of this Metric.
:rtype: str
hosts
Gets the hosts of this Metric.
 
Array of hostnames  # noqa: E501
 
:return: The hosts of this Metric.
:rtype: List[str]
id
Gets the id of this Metric.
 
Metric slug name. For basic metrics this is e.g. `ram`, `cpu`. For complex metrics this is concatenation produced as `cpx_{parent_id}_{moving_window_duration}_{interval}`  # noqa: E501
 
:return: The id of this Metric.
:rtype: str
interval
Gets the interval of this Metric.
 
Number of seconds between each new point in produced series  # noqa: E501
 
:return: The interval of this Metric.
:rtype: int
moving_window_duration
Gets the moving_window_duration of this Metric.
 
Duration of moving window in seconds  # noqa: E501
 
:return: The moving_window_duration of this Metric.
:rtype: int
parent_id
Gets the parent_id of this Metric.
 
Id of a metric on which is based the complex metric. For basic metric this value is set as `null`.  # noqa: E501
 
:return: The parent_id of this Metric.
:rtype: str
removable
Gets the removable of this Metric.
 
True if metric is owned by logged user  # noqa: E501
 
:return: The removable of this Metric.
:rtype: bool
unit
Gets the unit of this Metric.
 
String that should be appended to chart tooltip / legend eq. `%` or `Mb`  # noqa: E501
 
:return: The unit of this Metric.
:rtype: str

Methods inherited from rest_api.swagger_server.models.base_model_.Model:
__eq__(self, other)
Returns true if both objects are equal
__ne__(self, other)
Returns true if both objects are not equal
__repr__(self)
For `print` and `pprint`
to_dict(self)
Returns the model properties as a dict
 
:rtype: dict
to_str(self)
Returns the string representation of the model
 
:rtype: str

Data descriptors inherited from rest_api.swagger_server.models.base_model_.Model:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Data and other attributes inherited from rest_api.swagger_server.models.base_model_.Model:
__hash__ = None
attribute_map = {}
swagger_types = {}

 
Data
        absolute_import = _Feature((2, 5, 0, 'alpha', 1), (3, 0, 0, 'alpha', 0), 16384)