`aip_sdk.MetricConfigStatus`

aip_sdk.MetricConfigStatus(metric_name: str, is_required: bool, default_config_name: str | None, default_config_version: str | None, default_usage_count: int, overrides: list[MetricConfigOverrideStatus])

What one metric's config situation is in a workspace, for pre-run discovery.

An entry from discover_metric_config_status() — layers usage_count onto resolve_metric_configs()'s default/overrides shape, so a caller deciding "default, reuse, or author a new config?" reads it off one call.

Attributes

metric_name str: The metric implementation this status is for.
is_required bool: True only when the workspace has neither a published default nor any named override for this metric — a run must supply an explicit config. Rarely True: every agentic metric's default is auto-seeded at workspace creation, so this mainly catches a metric added after that seeding ran.
default_config_name str | None: The workspace default's config name, or None when is_required is True. Not a metric_config_refs target — see MetricConfigResolution.
default_config_version str | None: Same, for config version.
default_usage_count int: Runs pinning the materialized row for this default — 0 until dispatch first materializes it.
overrides list[MetricConfigOverrideStatus]: Every named override available to pin instead.