temporalio.common._NoopMetricGauge

class documentation

class _NoopMetricGauge(_NoopMetric, MetricGauge): (source)

Constructor: _NoopMetricGauge(name, description, unit)

View In Hierarchy

Undocumented

Method set Set a value on the gauge.
Method with_additional_attributes Create a new gauge with the given attributes appended to the current set.

Inherited from _NoopMetric:

Method __init__ Undocumented
Property description Undocumented
Property name Undocumented
Property unit Undocumented
Instance Variable _description Undocumented
Instance Variable _name Undocumented
Instance Variable _unit Undocumented
def set(self, value: int, additional_attributes: Optional[MetricAttributes] = None): (source)
overrides temporalio.common.MetricGauge.set

Set a value on the gauge.

Parameters
value:intA non-negative integer to set.
additional_attributes:Optional[MetricAttributes]Additional attributes to append to the current set.
Raises
ValueErrorValue is negative.
TypeErrorAttribute values are not the expected type.
def with_additional_attributes(self, additional_attributes: MetricAttributes) -> MetricGauge: (source)
overrides temporalio.common.MetricGauge.with_additional_attributes

Create a new gauge with the given attributes appended to the current set.

Parameters
additional_attributes:MetricAttributesAdditional attributes to append to the current set.
Returns
MetricGaugeNew gauge.
Raises
TypeErrorAttribute values are not the expected type.