Skip to content

DataqueryBuilder🔗

Constructor🔗

new DataqueryBuilder()

Methods🔗

build🔗

Builds the object.

public Dataquery build()

alias🔗

public dataqueryBuilder alias(String alias)

channel🔗

Used for live query

public dataqueryBuilder channel(String channel)

csvContent🔗

public dataqueryBuilder csvContent(String csvContent)

csvFileName🔗

public dataqueryBuilder csvFileName(String csvFileName)

csvWave🔗

public dataqueryBuilder csvWave(List<com.grafana.foundation.cog.Builder<CSVWave>> csvWave)

datasource🔗

The datasource

public dataqueryBuilder datasource(DataSourceRef datasource)

dropPercent🔗

Drop percentage (the chance we will lose a point 0-100)

public dataqueryBuilder dropPercent(Double dropPercent)

errorType🔗

Possible enum values:

  • "frontend_exception"

  • "frontend_observable"

  • "server_panic"

public dataqueryBuilder errorType(DataqueryErrorType errorType)

flamegraphDiff🔗

public dataqueryBuilder flamegraphDiff(Boolean flamegraphDiff)

hide🔗

true if query is disabled (ie should not be returned to the dashboard)

NOTE: this does not always imply that the query should not be executed since

the results from a hidden query may be used as the input to other queries (SSE etc)

public dataqueryBuilder hide(Boolean hide)

intervalMs🔗

Interval is the suggested duration between time points in a time series query.

NOTE: the values for intervalMs is not saved in the query model. It is typically calculated

from the interval required to fill a pixels in the visualization

public dataqueryBuilder intervalMs(Double intervalMs)

labels🔗

public dataqueryBuilder labels(String labels)

levelColumn🔗

public dataqueryBuilder levelColumn(Boolean levelColumn)

lines🔗

public dataqueryBuilder lines(Long lines)

max🔗

public dataqueryBuilder max(Double max)

maxDataPoints🔗

MaxDataPoints is the maximum number of data points that should be returned from a time series query.

NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated

from the number of pixels visible in a visualization

public dataqueryBuilder maxDataPoints(Long maxDataPoints)

min🔗

public dataqueryBuilder min(Double min)

nodes🔗

public dataqueryBuilder nodes(com.grafana.foundation.cog.Builder<NodesQuery> nodes)

noise🔗

public dataqueryBuilder noise(Double noise)

points🔗

public dataqueryBuilder points(List<List<Object>> points)

pulseWave🔗

public dataqueryBuilder pulseWave(com.grafana.foundation.cog.Builder<PulseWaveQuery> pulseWave)

queryType🔗

QueryType is an optional identifier for the type of query.

It can be used to distinguish different types of queries.

public dataqueryBuilder queryType(String queryType)

rawFrameContent🔗

public dataqueryBuilder rawFrameContent(String rawFrameContent)

refId🔗

RefID is the unique identifier of the query, set by the frontend call.

public dataqueryBuilder refId(String refId)

resultAssertions🔗

Optionally define expected query result behavior

public dataqueryBuilder resultAssertions(com.grafana.foundation.cog.Builder<ResultAssertions> resultAssertions)

scenarioId🔗

Possible enum values:

  • "annotations"

  • "arrow"

  • "csv_content"

  • "csv_file"

  • "csv_metric_values"

  • "datapoints_outside_range"

  • "exponential_heatmap_bucket_data"

  • "flame_graph"

  • "grafana_api"

  • "linear_heatmap_bucket_data"

  • "live"

  • "logs"

  • "manual_entry"

  • "no_data_points"

  • "node_graph"

  • "predictable_csv_wave"

  • "predictable_pulse"

  • "random_walk"

  • "random_walk_table"

  • "random_walk_with_error"

  • "raw_frame"

  • "server_error_500"

  • "simulation"

  • "slow_query"

  • "streaming_client"

  • "table_static"

  • "trace"

  • "usa"

  • "variables-query"

public dataqueryBuilder scenarioId(DataqueryScenarioId scenarioId)

seriesCount🔗

public dataqueryBuilder seriesCount(Long seriesCount)

sim🔗

public dataqueryBuilder sim(com.grafana.foundation.cog.Builder<SimulationQuery> sim)

spanCount🔗

public dataqueryBuilder spanCount(Long spanCount)

spread🔗

public dataqueryBuilder spread(Double spread)

startValue🔗

public dataqueryBuilder startValue(Double startValue)

stream🔗

public dataqueryBuilder stream(com.grafana.foundation.cog.Builder<StreamingQuery> stream)

stringInput🔗

common parameter used by many query types

public dataqueryBuilder stringInput(String stringInput)

timeRange🔗

TimeRange represents the query range

NOTE: unlike generic /ds/query, we can now send explicit time values in each query

NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly

public dataqueryBuilder timeRange(com.grafana.foundation.cog.Builder<TimeRange> timeRange)

usa🔗

public dataqueryBuilder usa(com.grafana.foundation.cog.Builder<USAQuery> usa)

withNil🔗

public dataqueryBuilder withNil(Boolean withNil)

See also🔗