Struct grafana_plugin_sdk::backend::CheckHealthResponse

#[non_exhaustive]
pub struct CheckHealthResponse {
    pub status: HealthStatus,
    pub message: String,
    pub json_details: Value,
}

The response to a health check request.

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.

status: HealthStatus

The status of the plugin.

message: String

A message associated with the health check.

json_details: Value

Any additional details to include with the response.

Implementations

impl CheckHealthResponse

pub fn new(status: HealthStatus, message: String, json_details: Value) -> Self

👎Deprecated since 1.3.0:

use ok/error/unknown constructors instead

Create a new CheckHealthResponse.

pub fn ok(message: String) -> Self

Create a CheckHealthResponse with status HealthStatus::Ok.

The JSON in json_details will be set to null; use CheckHealthResponse::with_json_details to override it.

pub fn error(message: String) -> Self

Create a CheckHealthResponse with status HealthStatus::Error.

The JSON in json_details will be set to null; use CheckHealthResponse::with_json_details to override it.

pub fn unknown(message: String) -> Self

Create a CheckHealthResponse with status HealthStatus::Unknown.

The JSON in json_details will be set to null; use CheckHealthResponse::with_json_details to override it.

pub fn with_json_details(self, json_details: Value) -> Self

Update self with the given JSON details, returning a new CheckHealthResponse.

Trait Implementations

impl Debug for CheckHealthResponse

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

Formats the value using the given formatter.

impl Default for CheckHealthResponse

fn default() -> Self

Returns the “default value” for a type.

impl From<CheckHealthResponse> for CheckHealthResponse

fn from(other: CheckHealthResponse) -> Self

Converts to this type from the input type.