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

Class BaseVariable

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

All Implemented Interfaces:

Json<J>, Variable

public class BaseVariable
implements Variable

Basic data of a variable, e.g. name and type.

It's recommended to use this class as some variable implementation's delegate (see class VariableWithQuery for example).

Mutable builder is not provided for this class because it's not recommended to use this class as is.

See Also:

class VariableWithQuery

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseVariable.Companion

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

Variable.DefaultImpls

Field Summary

Fields

Modifier and Type	Field and Description
static BaseVariable.Companion	Companion

Constructor Summary

Constructors

Constructor and Description
BaseVariable(java.lang.String name, java.lang.String type, java.lang.String displayName, HidingMode hidingMode) Basic data of a variable, e.g. name and type.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() name of a variable.
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

Field Detail

Companion

public static BaseVariable.Companion Companion

Constructor Detail

BaseVariable

public BaseVariable(java.lang.String name,
                    java.lang.String type,
                    java.lang.String displayName,
                    HidingMode hidingMode)

Basic data of a variable, e.g. name and type.

It's recommended to use this class as some variable implementation's delegate (see class VariableWithQuery for example).

Mutable builder is not provided for this class because it's not recommended to use this class as is.

Parameters:

name - name of a variable. You can refer to variable via this name.

type - type of a variable

displayName - display name of a variable. This name will be used as a label for variable at dashboardwhen HidingMode.NONE is used. When this value is missed so name will be used for variable label.

hidingMode - hiding mode of a variable

name - name of a variable. You can refer to variable via this name.

type - type of a variable

displayName - display name of a variable. This name will be used as a label for variable at dashboard when HidingMode.NONE is used. When this value is missed so name will be used for variable label.

hidingMode - hiding mode of a variable

See Also:

class VariableWithQuery

Method Detail

toJson

public org.json.JSONObject toJson()

returns object as JSON.

Returns:

JSON

getName

public java.lang.String getName()

name of a variable.

You can refer to variable via this name.