Skip to content

QueryBuilder🔗

Constructor🔗

new QueryBuilder()

Methods🔗

build🔗

Builds the object.

public Query build()

alias🔗

Alias pattern

public QueryBuilder alias(String alias)

bucketAggs🔗

List of bucket aggregations

public QueryBuilder bucketAggs(List<BucketAggregation> bucketAggs)

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)

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)

metrics🔗

List of metric aggregations

public QueryBuilder metrics(List<MetricAggregation> metrics)

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)

query🔗

Lucene query

public QueryBuilder query(String query)

queryType🔗

Specify the query flavor

TODO make this required and give it a default

public QueryBuilder queryType(String queryType)

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)

timeField🔗

Name of time field

public QueryBuilder timeField(String timeField)

version🔗

public QueryBuilder version(String version)

See also🔗