Skip to content

QueryVariableBuilder🔗

Constructor🔗

new QueryVariableBuilder(String name)

Methods🔗

build🔗

Builds the object.

public QueryVariable build()

allValue🔗

Custom all value

public QueryVariableBuilder allValue(String allValue)

allowCustomValue🔗

Allow custom values to be entered in the variable

public QueryVariableBuilder allowCustomValue(Boolean allowCustomValue)

current🔗

Shows current selected variable text/value on the dashboard

public QueryVariableBuilder current(VariableOption current)

datasource🔗

Data source used to fetch values for a variable. It can be defined but null.

public QueryVariableBuilder datasource(DataSourceRef datasource)

description🔗

Description of variable. It can be defined but null.

public QueryVariableBuilder description(String description)

hide🔗

Visibility configuration for the variable

public QueryVariableBuilder hide(VariableHide hide)

includeAll🔗

Whether all value option is available or not

public QueryVariableBuilder includeAll(Boolean includeAll)

label🔗

Optional display name

public QueryVariableBuilder label(String label)

multi🔗

Whether multiple values can be selected or not from variable value list

public QueryVariableBuilder multi(Boolean multi)

name🔗

Name of variable

public QueryVariableBuilder name(String name)

options🔗

Options that can be selected for a variable.

public QueryVariableBuilder options(List<VariableOption> options)

query🔗

Query used to fetch values for a variable

public QueryVariableBuilder query(StringOrMap query)

refresh🔗

Options to config when to refresh a variable

public QueryVariableBuilder refresh(VariableRefresh refresh)

regex🔗

Optional field, if you want to extract part of a series name or metric node segment.

Named capture groups can be used to separate the display text and value.

public QueryVariableBuilder regex(String regex)

sort🔗

Options sort order

public QueryVariableBuilder sort(VariableSort sort)

See also🔗