class documentation
class _MetricGauge(temporalio.common.MetricGauge): (source)
Constructor: _MetricGauge(name, description, unit, core_metric, ...)
Undocumented
Method | __init__ |
Undocumented |
Method | set |
Set a value on the gauge. |
Method | with |
Create a new gauge with the given attributes appended to the current set. |
Property | description |
Description for the metric if any. |
Property | name |
Name for the metric. |
Property | unit |
Unit for the metric if any. |
Instance Variable | _core |
Undocumented |
Instance Variable | _core |
Undocumented |
Instance Variable | _description |
Undocumented |
Instance Variable | _name |
Undocumented |
Instance Variable | _unit |
Undocumented |
def __init__(self, name:
str
, description: Optional[ str]
, unit: Optional[ str]
, core_metric: temporalio.bridge.metric.MetricGauge
, core_attrs: temporalio.bridge.metric.MetricAttributes
):
(source)
¶
Undocumented
def set(self, value:
int
, additional_attributes: Optional[ temporalio.common.MetricAttributes]
= None):
(source)
¶
overrides
temporalio.common.MetricGauge.set
Set a value on the gauge.
Parameters | |
value:int | A non-negative integer to set. |
additionalOptional[ | Additional attributes to append to the current set. |
Raises | |
ValueError | Value is negative. |
TypeError | Attribute values are not the expected type. |
def with_additional_attributes(self, additional_attributes:
temporalio.common.MetricAttributes
) -> temporalio.common.MetricGauge
:
(source)
¶
Create a new gauge with the given attributes appended to the current set.
Parameters | |
additionaltemporalio.common.MetricAttributes | Additional attributes to append to the current set. |
Returns | |
temporalio.common.MetricGauge | New gauge. |
Raises | |
TypeError | Attribute values are not the expected type. |