QueryBuilder🔗

Constructor🔗

new QueryBuilder()

Builds the object.

build()

Aliases can be set to modify the legend labels. e.g. {{metric.label.xxx}}. See docs for more detail.

aliasBy(aliasBy: string)

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.

datasource(ref: {
    name?: string;
})

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

hide(hide: boolean)

Time interval in milliseconds.

intervalMs(intervalMs: number)

PromQL sub-query properties.

promQLQuery(promQLQuery: cog.Builder<googlecloudmonitoring.PromQLQuery>)

Specify the query flavor

TODO make this required and give it a default

queryType(queryType: string)

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.

refId(refId: string)

SLO sub-query properties.

sloQuery(sloQuery: cog.Builder<googlecloudmonitoring.SLOQuery>)

GCM query type.

queryType: #QueryType

Time Series List sub-query properties.

timeSeriesList(timeSeriesList: cog.Builder<googlecloudmonitoring.TimeSeriesList>)

Time Series sub-query properties.

timeSeriesQuery(timeSeriesQuery: cog.Builder<googlecloudmonitoring.TimeSeriesQuery>)

version(version: string)