class documentation

Undocumented

Method __init__ 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.
Property description Description for the metric if any.
Property name Name for the metric.
Property unit Unit for the metric if any.
Instance Variable _underlying Undocumented
def __init__(self, underlying: temporalio.common.MetricGauge): (source)

Undocumented

def set(self, value: int, additional_attributes: Optional[temporalio.common.MetricAttributes] = None): (source)

Set a value on the gauge.

Parameters
value:intA non-negative integer to set.
additional_attributes:Optional[temporalio.common.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: temporalio.common.MetricAttributes) -> temporalio.common.MetricGauge: (source)

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

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

Description for the metric if any.

Unit for the metric if any.

_underlying = (source)

Undocumented