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

Class IntervalVariable

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

All Implemented Interfaces:

Json<J>, Variable

public class IntervalVariable
implements Variable

Variable that contains interval values that can be used in queries.

Nested Class Summary

Nested Classes

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

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

Variable.DefaultImpls

Constructor Summary

Constructors

Constructor and Description
IntervalVariable(java.lang.String name, java.lang.String displayName, HidingMode hidingMode, Duration[] values, boolean auto, int stepCount, Duration minInterval) Public constructor for class IntervalVariable.

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

IntervalVariable

public IntervalVariable(java.lang.String name,
                        java.lang.String displayName,
                        HidingMode hidingMode,
                        Duration[] values,
                        boolean auto,
                        int stepCount,
                        Duration minInterval)

Public constructor for class IntervalVariable.

Parameters:

name - see BaseVariable.name

displayName - see BaseVariable.displayName

hidingMode - see BaseVariable.hidingMode

values - intervals that will be serialized as CSV string

auto - when true the Auto option will be available to select on dashboard screen. The size of interval calculated as max(timerange / stepCount, minInterval).

stepCount - how many times should the current time range be divided to calculate auto interval. Ignored when auto is false.

minInterval - the minimal interval that can be calculated for auto interval. Ignored when auto is false.

See Also:

class IntervalVariable

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.