Skip to content

QueryVariableSpec🔗

Query variable specification

Definition🔗

class QueryVariableSpec:
    """
    Query variable specification
    """

    name: str
    current: dashboardv2beta1.VariableOption
    label: typing.Optional[str]
    hide: dashboardv2beta1.VariableHide
    refresh: dashboardv2beta1.VariableRefresh
    skip_url_sync: bool
    description: typing.Optional[str]
    query: dashboardv2beta1.DataQueryKind
    regex: str
    regex_apply_to: typing.Optional[dashboardv2beta1.VariableRegexApplyTo]
    sort: dashboardv2beta1.VariableSort
    definition: typing.Optional[str]
    options: list[dashboardv2beta1.VariableOption]
    multi: bool
    include_all: bool
    all_value: typing.Optional[str]
    placeholder: typing.Optional[str]
    allow_custom_value: bool
    static_options: typing.Optional[list[dashboardv2beta1.VariableOption]]
    static_options_order: typing.Optional[typing.Literal["before", "after", "sorted"]]

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