Skip to content

MetricToRetain

Source code in docs_src/capo_iot/types/metric_to_retain.py
class MetricToRetain(TypedDict, closed=True):
    metric: "capo_iot.types.behavior_metric.BehaviorMetric"
    """<p>What is measured by the behavior.</p>"""
    metric_dimension: NotRequired["capo_iot.types.metric_dimension.MetricDimension"]
    """<p>The dimension of a metric. This can't be used with custom metrics.</p>"""
    export_metric: NotRequired["capo_iot.types.export_metric.ExportMetric"]
    """<p>The value indicates exporting metrics related to the <code>MetricToRetain </code> when it's true.</p>"""

export_metric instance-attribute

export_metric: NotRequired[ExportMetric]

The value indicates exporting metrics related to the MetricToRetain when it's true.

metric instance-attribute

What is measured by the behavior.

metric_dimension instance-attribute

metric_dimension: NotRequired[MetricDimension]

The dimension of a metric. This can't be used with custom metrics.