PreflightCheck

Part of Diagnostics & preflight in the Python API reference.

Related guidance: getting-started/preflight, how-to/troubleshooting.

Runnable examples: preflight.py.

from picogrid_ecn_client import PreflightCheck

Report the outcome and duration of one MQTT preflight check.

PreflightCheck(
    *,
    name: PreflightCheckName,
    status: CheckStatus,
    required: bool = True,
    duration_ms: float,
    detail: str,
)

Source · models/diagnostics.py

Fields

Name	Type	Required	Default	Constraints	Description
name	PreflightCheckName	yes	—	—	Operation evaluated by this check.
status	CheckStatus	yes	—	—	Observed outcome of the check.
required	bool	no	True	—	Whether failure of this check prevents a successful report; defaults to true.
duration_ms	float	yes	—	ge=0, finite	Non-negative elapsed duration in milliseconds.
detail	str	yes	—	min_length=1, max_length=1024	Reader-facing outcome detail, from 1 through 1024 characters.