client.diagnostics
Generated methods for the diagnostics namespace.
Sync owner: WarmHubClient.diagnostics. Async owner: AsyncWarmHubClient.diagnostics.
Synchronous methods
Section titled “Synchronous methods”assert_compatible
Section titled “assert_compatible”assert_compatible(*, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET)Fail when this Python client and backend cannot safely write.
capabilities
Section titled “capabilities”capabilities(*, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> Capabilitiesdiagnostics.capabilities — query diagnostics.capabilities.
ping(*, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET)Health-check the configured backend URL. GET /health.
See AsyncGeneratedDiagnosticsRestMixin.ping.
Asynchronous methods
Section titled “Asynchronous methods”assert_compatible
Section titled “assert_compatible”assert_compatible(*, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET)Fail when this Python client and backend cannot safely write.
capabilities
Section titled “capabilities”capabilities(*, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> Capabilitiesdiagnostics.capabilities — query diagnostics.capabilities.
ping(*, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET)Health-check the configured backend URL. GET /health.
Uses the HTTP health endpoint rather than tRPC, so it distinguishes a connection failure from a procedure-level error.
A failing check always raises BACKEND with Health request failed with status N — it does not derive a kind from the status, because
mapping a 404 here to NOT_FOUND would answer the question ping was
asked with the answer it exists to rule out.
No extra_body: the request has no body to merge one into.