Package cm_api :: Package endpoints :: Module types :: Class ApiMetric

Class ApiMetric

   object --+    
            |    
BaseApiObject --+
                |
               ApiMetric

Metric information.

Instance Methods

[hide private]

__init__(self, resource_root)
Initializes internal state and sets all known writable properties of the object to None.

source code

Inherited from BaseApiObject: __setattr__, __str__, to_json_dict

Inherited from BaseApiObject (private): _check_attr, _get_resource_root, _set_attrs, _update

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __sizeof__, __subclasshook__

Class Methods

[hide private]

Inherited from BaseApiObject: from_json_dict

Inherited from BaseApiObject (private): _get_attributes

Static Methods

[hide private]

Inherited from BaseApiObject: init

Class Variables

[hide private]

_ATTRIBUTES = {'name': ROAttr(), 'context': ROAttr(), 'unit': ...

Inherited from BaseApiObject (private): _WHITELIST

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, resource_root)
(Constructor)

source code

Initializes internal state and sets all known writable properties of the object to None. Then initializes the properties given in the provided attributes dictionary.

Parameters:

resource_root - API resource object.
attrs - optional dictionary of attributes to set. This should only contain r/w attributes.

Overrides: object.__init__

(inherited documentation)

Class Variable Details

[hide private]

_ATTRIBUTES

Value:

{'name': ROAttr(), 'context': ROAttr(), 'unit': ROAttr(), 'data': ROAt
tr(ApiMetricData), 'displayName': ROAttr(), 'description': ROAttr(),}

Class ApiMetric

__init__(self, resource_root) (Constructor)

_ATTRIBUTES

init(self, resource_root)
(Constructor)