QueryBuilder🔗

Constructor🔗

new QueryBuilder()

Methods🔗

build🔗

Builds the object.

public Query build()

datasource🔗

New type for datasource reference

Not creating a new type until we figure out how to handle DS refs for group by, adhoc, and every place that uses DataSourceRef in TS.

public QueryBuilder datasource(com.grafana.foundation.cog.Builder<Dashboardv2beta1DataQueryKindDatasource> datasource)

editorMode🔗

Specifies which editor is being used to prepare the query. It can be "code" or "builder"

public QueryBuilder editorMode(QueryEditorMode editorMode)

exemplar🔗

Execute an additional query to identify interesting raw samples relevant for the given expr

public QueryBuilder exemplar(Boolean exemplar)

expr🔗

The actual expression/query that will be evaluated by Prometheus

public QueryBuilder expr(String expr)

format🔗

Query format to determine how to display data points in panel. It can be "time_series", "table", "heatmap"

public QueryBuilder format(PromQueryFormat format)

hide🔗

If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.

public QueryBuilder hide(Boolean hide)

instant🔗

Returns only the latest value that Prometheus has scraped for the requested time series

public QueryBuilder instant()

interval🔗

An additional lower limit for the step parameter of the Prometheus query and for the

$__interval and $__rate_interval variables.

public QueryBuilder interval(String interval)

intervalFactor🔗

@deprecated Used to specify how many times to divide max data points by. We use max data points under query options

See https://github.com/grafana/grafana/issues/48081

public QueryBuilder intervalFactor(Double intervalFactor)

legendFormat🔗

Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname

public QueryBuilder legendFormat(String legendFormat)

oldDatasource🔗

For mixed data sources the selected datasource is on the query level.

For non mixed scenarios this is undefined.

TODO find a better way to do this ^ that's friendly to schema

TODO this shouldn't be unknown but DataSourceRef | null

public QueryBuilder oldDatasource(DataSourceRef datasource)

queryType🔗

Specify the query flavor

TODO make this required and give it a default

public QueryBuilder queryType(String queryType)

range🔗

Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series

public QueryBuilder range()

rangeAndInstant🔗

public QueryBuilder rangeAndInstant()

refId🔗

A unique identifier for the query within the list of targets.

In server side expressions, the refId is used as a variable name to identify results.

By default, the UI will assign A->Z; however setting meaningful names may be useful.

public QueryBuilder refId(String refId)

version🔗

public QueryBuilder version(String version)