DashboardBuilder🔗

Constructor🔗

new DashboardBuilder(String title)

Methods🔗

build🔗

Builds the object.

public Dashboard build()

switchVariableKind🔗

public DashboardBuilder switchVariableKind(com.grafana.foundation.cog.Builder<SwitchVariableKind> switchVariableKind)

adhocVariable🔗

public DashboardBuilder adhocVariable(com.grafana.foundation.cog.Builder<AdhocVariableKind> adhocVariableKind)

annotations🔗

public DashboardBuilder annotations(List<com.grafana.foundation.cog.Builder<AnnotationQueryKind>> annotations)

autoGridLayout🔗

public DashboardBuilder autoGridLayout(com.grafana.foundation.cog.Builder<AutoGridLayoutKind> autoGridLayoutKind)

constantVariable🔗

public DashboardBuilder constantVariable(com.grafana.foundation.cog.Builder<ConstantVariableKind> constantVariableKind)

cursorSync🔗

Configuration of dashboard cursor sync behavior.

"Off" for no shared crosshair or tooltip (default).

"Crosshair" for shared crosshair.

"Tooltip" for shared crosshair AND shared tooltip.

public DashboardBuilder cursorSync(DashboardCursorSync cursorSync)

customVariable🔗

public DashboardBuilder customVariable(com.grafana.foundation.cog.Builder<CustomVariableKind> customVariableKind)

datasourceVariable🔗

public DashboardBuilder datasourceVariable(com.grafana.foundation.cog.Builder<DatasourceVariableKind> datasourceVariableKind)

description🔗

Description of dashboard.

public DashboardBuilder description(String description)

editable🔗

Whether a dashboard is editable or not.

public DashboardBuilder editable(Boolean editable)

elements🔗

public DashboardBuilder elements(Map<String, Element> elements)

gridLayout🔗

public DashboardBuilder gridLayout(com.grafana.foundation.cog.Builder<GridLayoutKind> gridLayoutKind)

groupByVariable🔗

public DashboardBuilder groupByVariable(com.grafana.foundation.cog.Builder<GroupByVariableKind> groupByVariableKind)

intervalVariable🔗

public DashboardBuilder intervalVariable(com.grafana.foundation.cog.Builder<IntervalVariableKind> intervalVariableKind)

libraryPanel🔗

public DashboardBuilder libraryPanel(String key, com.grafana.foundation.cog.Builder<LibraryPanelKind> libraryPanelKind)

links🔗

Links with references to other dashboards or external websites.

public DashboardBuilder links(List<com.grafana.foundation.cog.Builder<DashboardLink>> links)

liveNow🔗

When set to true, the dashboard will redraw panels at an interval matching the pixel width.

This will keep data "moving left" regardless of the query refresh rate. This setting helps

avoid dashboards presenting stale live data.

public DashboardBuilder liveNow(Boolean liveNow)

panel🔗

public DashboardBuilder panel(String key, com.grafana.foundation.cog.Builder<PanelKind> panelKind)

preload🔗

When set to true, the dashboard will load all panels in the dashboard when it's loaded.

public DashboardBuilder preload(Boolean preload)

queryVariable🔗

public DashboardBuilder queryVariable(com.grafana.foundation.cog.Builder<QueryVariableKind> queryVariableKind)

revision🔗

Plugins only. The version of the dashboard installed together with the plugin.

This is used to determine if the dashboard should be updated when the plugin is updated.

public DashboardBuilder revision(Short revision)

rowsLayout🔗

public DashboardBuilder rowsLayout(com.grafana.foundation.cog.Builder<RowsLayoutKind> rowsLayoutKind)

tabsLayout🔗

public DashboardBuilder tabsLayout(com.grafana.foundation.cog.Builder<TabsLayoutKind> tabsLayoutKind)

tags🔗

Tags associated with dashboard.

public DashboardBuilder tags(List<String> tags)

textVariable🔗

public DashboardBuilder textVariable(com.grafana.foundation.cog.Builder<TextVariableKind> textVariableKind)

timeSettings🔗

public DashboardBuilder timeSettings(com.grafana.foundation.cog.Builder<TimeSettingsSpec> timeSettings)

title🔗

Title of dashboard.

public DashboardBuilder title(String title)

variables🔗

Configured template variables.

public DashboardBuilder variables(List<VariableKind> variables)