Query🔗

Constructor🔗

Query()

Methods🔗

build🔗

Builds the object.

def build() -> dashboardv2beta1.DataQueryKind

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

group_by🔗

Allows to group the results.

def group_by(group_by: list[str]) -> 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

label_selector🔗

Specifies the query label selectors.

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

limit🔗

Sets the maximum number of time series.

def limit(limit: int) -> typing.Self

max_nodes🔗

Sets the maximum number of nodes in the flamegraph.

def max_nodes(max_nodes: int) -> 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

profile_type_id🔗

Specifies the type of profile to query.

def profile_type_id(profile_type_id: 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

span_selector🔗

Specifies the query span selectors.

def span_selector(span_selector: list[str]) -> typing.Self

version🔗

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