Skip to content

DataqueryBuilder🔗

Constructor🔗

new DataqueryBuilder()

Methods🔗

build🔗

Builds the object.

public Dataquery build()

alias🔗

Alias pattern

public dataqueryBuilder alias(String alias)

bucketAggs🔗

List of bucket aggregations

public dataqueryBuilder bucketAggs(List<BucketAggregation> bucketAggs)

datasource🔗

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 dataqueryBuilder datasource(DataSourceRef 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 dataqueryBuilder hide(Boolean hide)

metrics🔗

List of metric aggregations

public dataqueryBuilder metrics(List<MetricAggregation> metrics)

query🔗

Lucene query

public dataqueryBuilder query(String query)

queryType🔗

Specify the query flavor

TODO make this required and give it a default

public dataqueryBuilder 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 dataqueryBuilder refId(String refId)

timeField🔗

Name of time field

public dataqueryBuilder timeField(String timeField)

See also🔗