org.dashbuilder.dataset.def

Interface PrometheusDataSetDefBuilder<T extends DataSetDefBuilder>

All Superinterfaces:

DataSetDefBuilder<T>

All Known Implementing Classes:

PrometheusDataSetDefBuilderImpl

public interface PrometheusDataSetDefBuilder<T extends DataSetDefBuilder>
extends DataSetDefBuilder<T>

A builder for defining Prometheus data sets.

    DataSetDef dataSetDef = DataSetDefFactory.newPrometheusDataSetDef()
     .serverUrl("http://localhost:9090")
     .query("up")
     .attributes("metricAttribute1,metricAttribute2")
     .buildDef();
 

Method Summary

Modifier and Type	Method and Description
T	query(String query) Set the Prometheus query that will be used to build this dataset
T	serverUrl(String serverUrl) Set the data set server url

Methods inherited from interface org.dashbuilder.dataset.def.DataSetDefBuilder

buildDef, cacheOff, cacheOn, column, date, label, name, number, pushOff, pushOn, refreshOff, refreshOn, text, uuid

Method Detail

serverUrl

T serverUrl(String serverUrl)

Set the data set server url

Parameters:

className - The Prometheus server where this data set should send the queries to;

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

query

T query(String query)

Set the Prometheus query that will be used to build this dataset

Parameters:

query - The Prometheus query

paramValue - A string representation of the parameter value.

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.