Skip to content

CustomVariableSpec🔗

Custom variable specification

Definition🔗

class CustomVariableSpec:
    """
    Custom variable specification
    """

    name: str
    query: str
    current: dashboardv2beta1.VariableOption
    options: list[dashboardv2beta1.VariableOption]
    multi: bool
    include_all: bool
    all_value: typing.Optional[str]
    label: typing.Optional[str]
    hide: dashboardv2beta1.VariableHide
    skip_url_sync: bool
    description: typing.Optional[str]
    allow_custom_value: bool
    values_format: typing.Optional[typing.Literal["csv", "json"]]

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