Struct grafana_plugin_sdk::backend::QueryDataRequest

#[non_exhaustive]
pub struct QueryDataRequest<Q>
where
    Q: DeserializeOwned,
{
    pub plugin_context: PluginContext,
    pub headers: HashMap<String, String>,
    pub queries: Vec<DataQuery<Q>>,
}

A request for data made by Grafana.

Details of the request source can be found in plugin_context, while the actual plugins themselves are in queries.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

plugin_context: PluginContext

Details of the plugin instance from which the request originated.

If the request originates from a datasource instance, this will include details about the datasource instance in the data_source_instance_settings field.

headers: HashMap<String, String>

Headers included along with the request by Grafana.

queries: Vec<DataQuery<Q>>

The queries requested by a user or alert.

Each DataQuery contains a unique ref_id field which identifies the query to the frontend; this should be included in the corresponding DataResponse for each query.

Trait Implementations

impl<Q> Debug for QueryDataRequest<Q>

where Q: DeserializeOwned + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Q> TryFrom<QueryDataRequest> for QueryDataRequest<Q>

where Q: DeserializeOwned,

type Error = ConvertFromError

The type returned in the event of a conversion error.

fn try_from(other: QueryDataRequest) -> Result<Self, Self::Error>

Performs the conversion.