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

Class CustomVariable

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

All Implemented Interfaces:

Json<J>, Variable

public class CustomVariable
implements Variable

Variable that contains list of user predefined values.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomVariable.Builder Mutable for builder for setting up unnecessary properties of class CustomVariable.
static class	CustomVariable.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 CustomVariable.Companion	Companion

Constructor Summary

Constructors

Constructor and Description
CustomVariable(java.lang.String name, java.lang.String displayName, HidingMode hidingMode, boolean multiValuesAllowed, boolean includeAllValue, java.lang.String allValue, java.lang.String[] values) Public constructor for custom variable.

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

Field Detail

Companion

public static CustomVariable.Companion Companion

Constructor Detail

CustomVariable

public CustomVariable(java.lang.String name,
                      java.lang.String displayName,
                      HidingMode hidingMode,
                      boolean multiValuesAllowed,
                      boolean includeAllValue,
                      java.lang.String allValue,
                      java.lang.String[] values)

Public constructor for custom variable.

Parameters:

name - see BaseVariable.name

displayName - see BaseVariable.displayName

hidingMode - see BaseVariable.hidingMode

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

values - array of options for this variable. This array will be serialized as a CSV string.

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.