Skip to content

MetricDimension

Source code in docs_src/capo_iot/types/metric_dimension.py 
14
15
16
17
18
19
20
class MetricDimension(TypedDict, closed=True):
    dimension_name: "capo_iot.types.dimension_name.DimensionName"
    """<p>A unique identifier for the dimension.</p>"""
    operator: NotRequired[
        "capo_iot.types.dimension_value_operator.DimensionValueOperator"
    ]
    """<p>Defines how the <code>dimensionValues</code> of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the <code>IN</code> operator, a message will be counted only if its topic matches one of the topic filters. With <code>NOT_IN</code> operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is <code>null</code>), it will be interpreted as <code>IN</code>.</p>"""

dimension_name instance-attribute 

dimension_name: DimensionName

A unique identifier for the dimension.

operator instance-attribute 

operator: NotRequired[DimensionValueOperator]

Defines how the dimensionValues of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.