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)

direction🔗

public QueryBuilder direction(LokiQueryDirection direction)

editorMode🔗

public QueryBuilder editorMode(QueryEditorMode editorMode)

expr🔗

The LogQL query.

public QueryBuilder expr(String expr)

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🔗

@deprecated, now use queryType.

public QueryBuilder instant(Boolean instant)

legendFormat🔗

Used to override the name of the series.

public QueryBuilder legendFormat(String legendFormat)

maxLines🔗

Used to limit the number of log rows returned.

public QueryBuilder maxLines(Long maxLines)

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🔗

@deprecated, now use queryType.

public QueryBuilder range(Boolean range)

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)

resolution🔗

@deprecated, now use step.

public QueryBuilder resolution(Long resolution)

step🔗

Used to set step value for range queries.

public QueryBuilder step(String step)

version🔗

public QueryBuilder version(String version)