Skip to content

DimensionKeyDescription

Source code in docs_src/capo_pi/types/dimension_key_description.py 
14
15
16
17
18
19
20
21
22
23
24
class DimensionKeyDescription(TypedDict, closed=True):
    dimensions: NotRequired["capo_pi.types.dimension_map.DimensionMap"]
    """<p>A map of name-value pairs for the dimensions in the group.</p>"""
    total: NotRequired["capo_pi.types.double.Double"]
    """<p>The aggregated metric value for the dimensions, over the requested time range.</p>"""
    additional_metrics: NotRequired[
        "capo_pi.types.additional_metrics_map.AdditionalMetricsMap"
    ]
    """<p>A map that contains the value for each additional metric.</p>"""
    partitions: NotRequired["capo_pi.types.metric_values_list.MetricValuesList"]
    """<p>If <code>PartitionBy</code> was specified, <code>PartitionKeys</code> contains the dimensions that were.</p>"""

additional_metrics instance-attribute 

additional_metrics: NotRequired[AdditionalMetricsMap]

A map that contains the value for each additional metric.

dimensions instance-attribute 

dimensions: NotRequired[DimensionMap]

A map of name-value pairs for the dimensions in the group.

partitions instance-attribute 

partitions: NotRequired[MetricValuesList]

If PartitionBy was specified, PartitionKeys contains the dimensions that were.

total instance-attribute 

total: NotRequired[Double]

The aggregated metric value for the dimensions, over the requested time range.