Skip to content

AdhocVariableSpec🔗

Adhoc variable specification

Definition🔗

class AdhocVariableSpec:
    """
    Adhoc variable specification
    """

    name: str
    base_filters: list[dashboardv2.AdHocFilterWithLabels]
    filters: list[dashboardv2.AdHocFilterWithLabels]
    default_keys: list[dashboardv2.MetricFindValue]
    label: typing.Optional[str]
    hide: dashboardv2.VariableHide
    skip_url_sync: bool
    description: typing.Optional[str]
    allow_custom_value: bool
    # Whether the group-by operator is enabled in the ad hoc filter combobox.
    enable_group_by: typing.Optional[bool]
    origin: typing.Optional[dashboardv2.ControlSourceRef]

Methods🔗

to_json🔗

Converts this object into a representation that can easily be encoded to JSON.

def to_json() -> dict[str, object]

from_json🔗

Builds this object from a JSON-decoded dict.

@classmethod
def from_json(data: dict[str, typing.Any]) -> typing.Self