Query🔗

Constructor🔗

Query()

Methods🔗

build🔗

Builds the object.

def build() -> dashboardv2beta1.DataQueryKind

alias🔗

Alias pattern

def alias(alias: str) -> typing.Self

bucket_aggs🔗

List of bucket aggregations

def bucket_aggs(bucket_aggs: list[cogbuilder.Builder[elasticsearch.BucketAggregation]]) -> typing.Self

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.

def datasource(ref: cogbuilder.Builder[dashboardv2beta1.Dashboardv2beta1DataQueryKindDatasource]) -> typing.Self

hide🔗

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

def hide(hide: bool) -> typing.Self

metrics🔗

List of metric aggregations

def metrics(metrics: list[cogbuilder.Builder[elasticsearch.MetricAggregation]]) -> typing.Self

old_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

def old_datasource(datasource: common.DataSourceRef) -> typing.Self

query🔗

Lucene query

def query(query: str) -> typing.Self

query_type🔗

Specify the query flavor

TODO make this required and give it a default

def query_type(query_type: str) -> typing.Self

ref_id🔗

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.

def ref_id(ref_id: str) -> typing.Self

time_field🔗

Name of time field

def time_field(time_field: str) -> typing.Self

version🔗

def version(version: str) -> typing.Self

See also🔗

• dashboardv2beta1.DataQueryKind