ru.yandex.money.tools.grafana.dsl.variables

Class QueryVariable

ru.yandex.money.tools.grafana.dsl.variables.QueryVariable

All Implemented Interfaces:

Json<J>, Variable

public class QueryVariable
implements Variable

Variable that uses query from given datasource to define variable values.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryVariable.Builder Mutable builder for setting up unnecessary properties for class QueryVariable.

Nested classes/interfaces inherited from interface ru.yandex.money.tools.grafana.dsl.variables.Variable

Variable.DefaultImpls

Constructor Summary

Constructors

Constructor and Description
QueryVariable(java.lang.String name, java.lang.String displayName, HidingMode hidingMode, java.lang.String query, Datasource datasource, RefreshMode refreshMode, java.lang.String regex, SortOrder sortOrder, boolean multiValuesAllowed, boolean includeAllValue, java.lang.String allValue) Public constructor for class QueryVariable.

Method Summary

Modifier and Type	Method and Description
java.lang.String	asVariable() Returns string representation of this variable.
java.lang.String	getName() Variable name.
org.json.JSONObject	toJson() returns object as JSON.

Methods inherited from interface ru.yandex.money.tools.grafana.dsl.variables.Variable

asVariable, getName

Methods inherited from interface ru.yandex.money.tools.grafana.dsl.json.Json

toJson

Constructor Detail

QueryVariable

public QueryVariable(java.lang.String name,
                     java.lang.String displayName,
                     HidingMode hidingMode,
                     java.lang.String query,
                     Datasource datasource,
                     RefreshMode refreshMode,
                     java.lang.String regex,
                     SortOrder sortOrder,
                     boolean multiValuesAllowed,
                     boolean includeAllValue,
                     java.lang.String allValue)

Public constructor for class QueryVariable.

Parameters:

name - see BaseVariable.name

displayName - see BaseVariable.displayName

hidingMode - see BaseVariable.hidingMode

query - query that will be used to retrieve variable values from given datasource. Syntax of query depends on datasource.

datasource - a datasource for variable values

refreshMode - a strategy that defines when variable values will be queried and updated.

regex - a regular expression that can be used to filter values that received from datasource. If this value is missing all received values will be used.

sortOrder - an order that declares how values will be sorted. It may matter if this variable is used for templating purposes.

multiValuesAllowed - enables multiple values selected at the same time

includeAllValue - when true the All option is available to select

allValue - optional value that will be used when All option is selected. Ignored by Grafana when includeAllValue is false

See Also:

class QueryVariable

Method Detail

toJson

public org.json.JSONObject toJson()

returns object as JSON.

Returns:

JSON

getName

public java.lang.String getName()

Variable name.

asVariable

public java.lang.String asVariable()

Returns string representation of this variable.